commit 17a73526cd0402e6e831b6bea5a2149554ffd239 Author: Saad Zaher Date: Thu Mar 9 12:39:48 2017 +0000 Big Bang :) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6b254e3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +Gemfile.lock +spec/fixtures/modules/* +spec/fixtures/manifests/site.pp +*.swp +pkg +vendor/ +/openstack/ + +# Files created by releasenotes build +releasenotes/build +.tox diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..00e2545 --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/puppet-freezer.git diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..45ac071 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2017 OpenStack Foundation + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca4106d --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +freezer +======= + +#### Table of Contents + +1. [Overview - What is the freezer module?](#overview) +2. [Module Description - What does the module do?](#module-description) +3. [Setup - The basics of getting started with freezer](#setup) +4. [Implementation - An under-the-hood peek at what the module is doing](#implementation) +5. [Limitations - OS compatibility, etc.](#limitations) +6. [Development - Guide for contributing to the module](#development) +7. [Contributors - Those with commits](#contributors) + +Overview +-------- + +The freezer module is a part of [OpenStack](https://www.openstack.org), an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects not part of the core software. The module its self is used to flexibly configure and manage the FIXME service for OpenStack. + +Module Description +------------------ + +The freezer module is a thorough attempt to make Puppet capable of managing the entirety of freezer. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the freezer module to assist in manipulation of configuration files. + +Setup +----- + +**What the freezer module affects** + +* [Freezer](https://wiki.openstack.org/wiki/Freezer), the FIXME service for OpenStack. + +### Installing freezer + + freezer is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install freezer with: + puppet module install openstack/freezer + +### Beginning with freezer + +To utilize the freezer module's functionality you will need to declare multiple resources. + +Implementation +-------------- + +### freezer + +freezer is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers. + +Limitations +------------ + +* All the freezer types use the CLI tools and so need to be ran on the freezer node. + +Beaker-Rspec +------------ + +This module has beaker-rspec tests + +To run the tests on the default vagrant node: + +```shell +bundle install +bundle exec rake acceptance +``` + +For more information on writing and running beaker-rspec tests visit the documentation: + +* https://github.com/puppetlabs/beaker-rspec/blob/master/README.md + +Development +----------- + +Developer documentation for the entire puppet-openstack project. + +* http://docs.openstack.org/developer/puppet-openstack-guide/ + +Contributors +------------ + +* https://github.com/openstack/puppet-freezer/graphs/contributors diff --git a/lib/puppet/provider/freezer_config/ini_setting.rb b/lib/puppet/provider/freezer_config/ini_setting.rb new file mode 100644 index 0000000..6213377 --- /dev/null +++ b/lib/puppet/provider/freezer_config/ini_setting.rb @@ -0,0 +1,10 @@ +Puppet::Type.type(:freezer_config).provide( + :ini_setting, + :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting) +) do + + def self.file_path + '/etc/freezer/freezer.conf' + end + +end diff --git a/lib/puppet/type/freezer_config.rb b/lib/puppet/type/freezer_config.rb new file mode 100644 index 0000000..54ba824 --- /dev/null +++ b/lib/puppet/type/freezer_config.rb @@ -0,0 +1,53 @@ +Puppet::Type.newtype(:freezer_config) do + + ensurable + + newparam(:name, :namevar => true) do + desc 'Section/setting name to manage from freezer.conf' + newvalues(/\S+\/\S+/) + end + + newproperty(:value) do + desc 'The value of the setting to be defined.' + munge do |value| + value = value.to_s.strip + value.capitalize! if value =~ /^(true|false)$/i + value + end + newvalues(/^[\S ]*$/) + + def is_to_s( currentvalue ) + if resource.secret? + return '[old secret redacted]' + else + return currentvalue + end + end + + def should_to_s( newvalue ) + if resource.secret? + return '[new secret redacted]' + else + return newvalue + end + end + end + + newparam(:secret, :boolean => true) do + desc 'Whether to hide the value from Puppet logs. Defaults to `false`.' + + newvalues(:true, :false) + + defaultto false + end + + newparam(:ensure_absent_val) do + desc 'A value that is specified as the value property will behave as if ensure => absent was specified' + defaultto('') + end + + autorequire(:package) do + 'freezer' + end + +end diff --git a/manifests/config.pp b/manifests/config.pp new file mode 100644 index 0000000..9198dcc --- /dev/null +++ b/manifests/config.pp @@ -0,0 +1,30 @@ +# == Class: freezer::config +# +# This class is used to manage arbitrary freezer configurations. +# +# === Parameters +# +# [*freezer_config*] +# (optional) Allow configuration of arbitrary freezer configurations. +# The value is an hash of freezer_config resources. Example: +# { 'DEFAULT/foo' => { value => 'fooValue'}, +# 'DEFAULT/bar' => { value => 'barValue'} +# } +# In yaml format, Example: +# freezer_config: +# DEFAULT/foo: +# value: fooValue +# DEFAULT/bar: +# value: barValue +# +# NOTE: The configuration MUST NOT be already handled by this module +# or Puppet catalog compilation will fail with duplicate resources. +# +class freezer::config ( + $freezer_config = {}, +) { + + validate_hash($freezer_config) + + create_resources('freezer_config', $freezer_config) +} diff --git a/manifests/db.pp b/manifests/db.pp new file mode 100644 index 0000000..f34e9d3 --- /dev/null +++ b/manifests/db.pp @@ -0,0 +1,65 @@ +# == Class: freezer::db +# +# Configure the freezer database +# +# === Parameters +# +# [*database_connection*] +# (Optional) Url used to connect to database. +# Defaults to 'sqlite:////var/lib/freezer/freezer.sqlite'. +# +# [*database_idle_timeout*] +# (Optional) Timeout when db connections should be reaped. +# Defaults to $::os_service_default +# +# [*database_db_max_retries*] +# (optional) Maximum retries in case of connection error or deadlock error +# before error is raised. Set to -1 to specify an infinite retry count. +# Defaults to $::os_service_default +# +# [*database_max_retries*] +# (Optional) Maximum number of database connection retries during startup. +# Setting -1 implies an infinite retry count. +# Defaults to $::os_service_default +# +# [*database_retry_interval*] +# (Optional) Interval between retries of opening a database connection. +# Defaults to $::os_service_default +# +# [*database_min_pool_size*] +# (Optional) Minimum number of SQL connections to keep open in a pool. +# Defaults to $::os_service_default +# +# [*database_max_pool_size*] +# (Optional)Maximum number of SQL connections to keep open in a pool. +# Defaults to $::os_service_default +# +# [*database_max_overflow*] +# (Optional) If set, use this value for max_overflow with sqlalchemy. +# Defaults to $::os_service_default +# +class freezer::db ( + $database_connection = 'sqlite:////var/lib/freezer/freezer.sqlite', + $database_idle_timeout = $::os_service_default, + $database_min_pool_size = $::os_service_default, + $database_max_pool_size = $::os_service_default, + $database_db_max_retries = $::os_service_default, + $database_max_retries = $::os_service_default, + $database_retry_interval = $::os_service_default, + $database_max_overflow = $::os_service_default, +) { + + validate_re($database_connection, + '^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?') + + oslo::db { 'freezer_config': + connection => $database_connection, + idle_timeout => $database_idle_timeout, + min_pool_size => $database_min_pool_size, + db_max_retries => $database_db_max_retries, + max_retries => $database_max_retries, + retry_interval => $database_retry_interval, + max_pool_size => $database_max_pool_size, + max_overflow => $database_max_overflow, + } +} diff --git a/manifests/db/mysql.pp b/manifests/db/mysql.pp new file mode 100644 index 0000000..875dc5b --- /dev/null +++ b/manifests/db/mysql.pp @@ -0,0 +1,69 @@ +# The freezer::db::mysql class implements mysql backend for freezer +# +# This class can be used to create tables, users and grant +# privilege for a mysql freezer database. +# +# == parameters +# +# [*password*] +# (Mandatory) Password to connect to the database. +# Defaults to 'false'. +# +# [*dbname*] +# (Optional) Name of the database. +# Defaults to 'freezer'. +# +# [*user*] +# (Optional) User to connect to the database. +# Defaults to 'freezer'. +# +# [*host*] +# (Optional) The default source host user is allowed to connect from. +# Defaults to '127.0.0.1' +# +# [*allowed_hosts*] +# (Optional) Other hosts the user is allowed to connect from. +# Defaults to 'undef'. +# +# [*charset*] +# (Optional) The database charset. +# Defaults to 'utf8' +# +# [*collate*] +# (Optional) The database collate. +# Only used with mysql modules >= 2.2. +# Defaults to 'utf8_general_ci' +# +# == Dependencies +# Class['mysql::server'] +# +# == Examples +# +# == Authors +# +# == Copyright +# +class freezer::db::mysql( + $password, + $dbname = 'freezer', + $user = 'freezer', + $host = '127.0.0.1', + $charset = 'utf8', + $collate = 'utf8_general_ci', + $allowed_hosts = undef +) { + + validate_string($password) + + ::openstacklib::db::mysql { 'freezer': + user => $user, + password_hash => mysql_password($password), + dbname => $dbname, + host => $host, + charset => $charset, + collate => $collate, + allowed_hosts => $allowed_hosts, + } + + ::Openstacklib::Db::Mysql['freezer'] ~> Exec<| title == 'freezer-manage db_sync' |> +} diff --git a/manifests/db/postgresql.pp b/manifests/db/postgresql.pp new file mode 100644 index 0000000..3cb88ba --- /dev/null +++ b/manifests/db/postgresql.pp @@ -0,0 +1,55 @@ +# == Class: freezer::db::postgresql +# +# Class that configures postgresql for freezer +# Requires the Puppetlabs postgresql module. +# +# === Parameters +# +# [*password*] +# (Required) Password to connect to the database. +# +# [*dbname*] +# (Optional) Name of the database. +# Defaults to 'freezer'. +# +# [*user*] +# (Optional) User to connect to the database. +# Defaults to 'freezer'. +# +# [*encoding*] +# (Optional) The charset to use for the database. +# Default to undef. +# +# [*privileges*] +# (Optional) Privileges given to the database user. +# Default to 'ALL' +# +# == Dependencies +# +# == Examples +# +# == Authors +# +# == Copyright +# +class freezer::db::postgresql( + $password, + $dbname = 'freezer', + $user = 'freezer', + $encoding = undef, + $privileges = 'ALL', +) { + + Class['freezer::db::postgresql'] -> Service<| title == 'freezer' |> + + ::openstacklib::db::postgresql { 'freezer': + password_hash => postgresql_password($user, $password), + dbname => $dbname, + user => $user, + encoding => $encoding, + privileges => $privileges, + } + + ::Openstacklib::Db::Postgresql['freezer'] ~> Exec<| title == 'freezer-manage db_sync' |> + +} diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp new file mode 100644 index 0000000..128d173 --- /dev/null +++ b/manifests/db/sync.pp @@ -0,0 +1,26 @@ +# +# Class to execute freezer-manage db_sync +# +# == Parameters +# +# [*extra_params*] +# (optional) String of extra command line parameters to append +# to the freezer-dbsync command. +# Defaults to undef +# +class freezer::db::sync( + $extra_params = undef, +) { + exec { 'freezer-db-sync': + command => "freezer-manage db_sync ${extra_params}", + path => [ '/bin', '/usr/bin', ], + user => 'freezer', + refreshonly => true, + try_sleep => 5, + tries => 10, + logoutput => on_failure, + subscribe => [Package['freezer'], Freezer_config['database/connection']], + } + + Exec['freezer-manage db_sync'] ~> Service<| title == 'freezer' |> +} diff --git a/manifests/init.pp b/manifests/init.pp new file mode 100644 index 0000000..4cbc0c2 --- /dev/null +++ b/manifests/init.pp @@ -0,0 +1,14 @@ +# == Class: freezer +# +# Full description of class freezer here. +# +# === Parameters +# +# [*sample_parameter*] +# Explanation of what this parameter affects and what it defaults to. +# +class freezer { + + include ::freezer::params + +} diff --git a/manifests/keystone/auth.pp b/manifests/keystone/auth.pp new file mode 100644 index 0000000..4d0548b --- /dev/null +++ b/manifests/keystone/auth.pp @@ -0,0 +1,99 @@ +# == Class: freezer::keystone::auth +# +# Configures freezer user, service and endpoint in Keystone. +# +# === Parameters +# +# [*password*] +# (required) Password for freezer user. +# +# [*ensure*] +# (optional) Ensure state of keystone service identity. Defaults to 'present'. +# +# [*auth_name*] +# Username for freezer service. Defaults to 'freezer'. +# +# [*email*] +# Email for freezer user. Defaults to 'freezer@localhost'. +# +# [*tenant*] +# Tenant for freezer user. Defaults to 'services'. +# +# [*configure_endpoint*] +# Should freezer endpoint be configured? Defaults to 'true'. +# +# [*configure_user*] +# (Optional) Should the service user be configured? +# Defaults to 'true'. +# +# [*configure_user_role*] +# (Optional) Should the admin role be configured for the service user? +# Defaults to 'true'. +# +# [*service_type*] +# Type of service. Defaults to 'key-manager'. +# +# [*region*] +# Region for endpoint. Defaults to 'RegionOne'. +# +# [*service_name*] +# (optional) Name of the service. +# Defaults to the value of 'freezer'. +# +# [*service_description*] +# (optional) Description of the service. +# Default to 'freezer FIXME Service' +# +# [*public_url*] +# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:FIXME') +# This url should *not* contain any trailing '/'. +# +# [*admin_url*] +# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:FIXME') +# This url should *not* contain any trailing '/'. +# +# [*internal_url*] +# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:FIXME') +# +class freezer::keystone::auth ( + $password, + $ensure = 'present', + $auth_name = 'freezer', + $email = 'freezer@localhost', + $tenant = 'services', + $configure_endpoint = true, + $configure_user = true, + $configure_user_role = true, + $service_name = 'freezer', + $service_description = 'freezer FIXME Service', + $service_type = 'FIXME', + $region = 'RegionOne', + $public_url = 'http://127.0.0.1:FIXME', + $admin_url = 'http://127.0.0.1:FIXME', + $internal_url = 'http://127.0.0.1:FIXME', +) { + + if $configure_user_role { + Keystone_user_role["${auth_name}@${tenant}"] ~> Service <| name == 'freezer-server' |> + } + Keystone_endpoint["${region}/${service_name}::${service_type}"] ~> Service <| name == 'freezer-server' |> + + keystone::resource::service_identity { 'freezer': + ensure => $ensure, + configure_user => $configure_user, + configure_user_role => $configure_user_role, + configure_endpoint => $configure_endpoint, + service_name => $service_name, + service_type => $service_type, + service_description => $service_description, + region => $region, + auth_name => $auth_name, + password => $password, + email => $email, + tenant => $tenant, + public_url => $public_url, + internal_url => $internal_url, + admin_url => $admin_url, + } + +} diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp new file mode 100644 index 0000000..ed4151f --- /dev/null +++ b/manifests/keystone/authtoken.pp @@ -0,0 +1,263 @@ +# class: freezer::keystone::auth +# +# Configure the keystone_authtoken section in the configuration file +# +# === Parameters +# +# [*username*] +# (Optional) The name of the service user +# Defaults to 'freezer' +# +# [*password*] +# (Required) Password to create for the service user +# +# [*auth_url*] +# (Optional) The URL to use for authentication. +# Defaults to 'http://localhost:35357'. +# +# [*project_name*] +# (Optional) Service project name +# Defaults to 'services' +# +# [*user_domain_name*] +# (Optional) Name of domain for $username +# Defaults to $::os_service_default +# +# [*project_domain_name*] +# (Optional) Name of domain for $project_name +# Defaults to $::os_service_default +# +# [*insecure*] +# (Optional) If true, explicitly allow TLS without checking server cert +# against any certificate authorities. WARNING: not recommended. Use with +# caution. +# Defaults to $:os_service_default +# +# [*auth_section*] +# (Optional) Config Section from which to load plugin specific options +# Defaults to $::os_service_default. +# +# [*auth_type*] +# (Optional) Authentication type to load +# Defaults to 'password'. +# +# [*auth_uri*] +# (Optional) Complete public Identity API endpoint. +# Defaults to 'http://localhost:5000'. +# +# [*auth_version*] +# (Optional) API version of the admin Identity API endpoint. +# Defaults to $::os_service_default. +# +# [*cache*] +# (Optional) Env key for the swift cache. +# Defaults to $::os_service_default. +# +# [*cafile*] +# (Optional) A PEM encoded Certificate Authority to use when verifying HTTPs +# connections. +# Defaults to $::os_service_default. +# +# [*certfile*] +# (Optional) Required if identity server requires client certificate +# Defaults to $::os_service_default. +# +# [*check_revocations_for_cached*] +# (Optional) If true, the revocation list will be checked for cached tokens. +# This requires that PKI tokens are configured on the identity server. +# boolean value. +# Defaults to $::os_service_default. +# +# [*delay_auth_decision*] +# (Optional) Do not handle authorization requests within the middleware, but +# delegate the authorization decision to downstream WSGI components. Boolean +# value +# Defaults to $::os_service_default. +# +# [*enforce_token_bind*] +# (Optional) Used to control the use and type of token binding. Can be set +# to: "disabled" to not check token binding. "permissive" (default) to +# validate binding information if the bind type is of a form known to the +# server and ignore it if not. "strict" like "permissive" but if the bind +# type is unknown the token will be rejected. "required" any form of token +# binding is needed to be allowed. Finally the name of a binding method that +# must be present in tokens. String value. +# Defaults to $::os_service_default. +# +# [*hash_algorithms*] +# (Optional) Hash algorithms to use for hashing PKI tokens. This may be a +# single algorithm or multiple. The algorithms are those supported by Python +# standard hashlib.new(). The hashes will be tried in the order given, so put +# the preferred one first for performance. The result of the first hash will +# be stored in the cache. This will typically be set to multiple values only +# while migrating from a less secure algorithm to a more secure one. Once all +# the old tokens are expired this option should be set to a single value for +# better performance. List value. +# Defaults to $::os_service_default. +# +# [*http_connect_timeout*] +# (Optional) Request timeout value for communicating with Identity API +# server. +# Defaults to $::os_service_default. +# +# [*http_request_max_retries*] +# (Optional) How many times are we trying to reconnect when communicating +# with Identity API Server. Integer value +# Defaults to $::os_service_default. +# +# [*include_service_catalog*] +# (Optional) Indicate whether to set the X-Service-Catalog header. If False, +# middleware will not ask for service catalog on token validation and will +# not set the X-Service-Catalog header. Boolean value. +# Defaults to $::os_service_default. +# +# [*keyfile*] +# (Optional) Required if identity server requires client certificate +# Defaults to $::os_service_default. +# +# [*memcache_pool_conn_get_timeout*] +# (Optional) Number of seconds that an operation will wait to get a memcached +# client connection from the pool. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_dead_retry*] +# (Optional) Number of seconds memcached server is considered dead before it +# is tried again. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_maxsize*] +# (Optional) Maximum total number of open connections to every memcached +# server. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_socket_timeout*] +# (Optional) Number of seconds a connection to memcached is held unused in +# the pool before it is closed. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_unused_timeout*] +# (Optional) Number of seconds a connection to memcached is held unused in +# the pool before it is closed. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_secret_key*] +# (Optional, mandatory if memcache_security_strategy is defined) This string +# is used for key derivation. +# Defaults to $::os_service_default. +# +# [*memcache_security_strategy*] +# (Optional) If defined, indicate whether token data should be authenticated +# or authenticated and encrypted. If MAC, token data is authenticated (with +# HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the +# cache. If the value is not one of these options or empty, auth_token will +# raise an exception on initialization. +# Defaults to $::os_service_default. +# +# [*memcache_use_advanced_pool*] +# (Optional) Use the advanced (eventlet safe) memcached client pool. The +# advanced pool will only work under python 2.x Boolean value +# Defaults to $::os_service_default. +# +# [*memcached_servers*] +# (Optional) Optionally specify a list of memcached server(s) to use for +# caching. If left undefined, tokens will instead be cached in-process. +# Defaults to $::os_service_default. +# +# [*manage_memcache_package*] +# (Optional) Whether to install the python-memcache package. +# Defaults to false. +# +# [*region_name*] +# (Optional) The region in which the identity server can be found. +# Defaults to $::os_service_default. +# +# [*revocation_cache_time*] +# (Optional) Determines the frequency at which the list of revoked tokens is +# retrieved from the Identity service (in seconds). A high number of +# revocation events combined with a low cache duration may significantly +# reduce performance. Only valid for PKI tokens. Integer value +# Defaults to $::os_service_default. +# +# [*token_cache_time*] +# (Optional) In order to prevent excessive effort spent validating tokens, +# the middleware caches previously-seen tokens for a configurable duration +# (in seconds). Set to -1 to disable caching completely. Integer value +# Defaults to $::os_service_default. +# +class freezer::keystone::authtoken( + $password, + $username = 'freezer', + $auth_url = 'http://localhost:35357', + $project_name = 'services', + $user_domain_name = $::os_service_default, + $project_domain_name = $::os_service_default, + $insecure = $::os_service_default, + $auth_section = $::os_service_default, + $auth_type = 'password', + $auth_uri = 'http://localhost:5000', + $auth_version = $::os_service_default, + $cache = $::os_service_default, + $cafile = $::os_service_default, + $certfile = $::os_service_default, + $check_revocations_for_cached = $::os_service_default, + $delay_auth_decision = $::os_service_default, + $enforce_token_bind = $::os_service_default, + $hash_algorithms = $::os_service_default, + $http_connect_timeout = $::os_service_default, + $http_request_max_retries = $::os_service_default, + $include_service_catalog = $::os_service_default, + $keyfile = $::os_service_default, + $memcache_pool_conn_get_timeout = $::os_service_default, + $memcache_pool_dead_retry = $::os_service_default, + $memcache_pool_maxsize = $::os_service_default, + $memcache_pool_socket_timeout = $::os_service_default, + $memcache_pool_unused_timeout = $::os_service_default, + $memcache_secret_key = $::os_service_default, + $memcache_security_strategy = $::os_service_default, + $memcache_use_advanced_pool = $::os_service_default, + $memcached_servers = $::os_service_default, + $manage_memcache_package = false, + $region_name = $::os_service_default, + $revocation_cache_time = $::os_service_default, + $token_cache_time = $::os_service_default, +) { + + keystone::resource::authtoken { 'freezer_config': + username => $username, + password => $password, + project_name => $project_name, + auth_url => $auth_url, + auth_uri => $auth_uri, + auth_version => $auth_version, + auth_type => $auth_type, + auth_section => $auth_section, + user_domain_name => $user_domain_name, + project_domain_name => $project_domain_name, + insecure => $insecure, + cache => $cache, + cafile => $cafile, + certfile => $certfile, + check_revocations_for_cached => $check_revocations_for_cached, + delay_auth_decision => $delay_auth_decision, + enforce_token_bind => $enforce_token_bind, + hash_algorithms => $hash_algorithms, + http_connect_timeout => $http_connect_timeout, + http_request_max_retries => $http_request_max_retries, + include_service_catalog => $include_service_catalog, + keyfile => $keyfile, + memcache_pool_conn_get_timeout => $memcache_pool_conn_get_timeout, + memcache_pool_dead_retry => $memcache_pool_dead_retry, + memcache_pool_maxsize => $memcache_pool_maxsize, + memcache_pool_socket_timeout => $memcache_pool_socket_timeout, + memcache_secret_key => $memcache_secret_key, + memcache_security_strategy => $memcache_security_strategy, + memcache_use_advanced_pool => $memcache_use_advanced_pool, + memcache_pool_unused_timeout => $memcache_pool_unused_timeout, + memcached_servers => $memcached_servers, + manage_memcache_package => $manage_memcache_package, + region_name => $region_name, + revocation_cache_time => $revocation_cache_time, + token_cache_time => $token_cache_time, + } +} + diff --git a/manifests/logging.pp b/manifests/logging.pp new file mode 100644 index 0000000..818b94d --- /dev/null +++ b/manifests/logging.pp @@ -0,0 +1,135 @@ +# Class freezer::logging +# +# freezer logging configuration +# +# == parameters +# +# [*debug*] +# (Optional) Should the daemons log debug messages +# Defaults to $::os_service_default +# +# [*use_syslog*] +# (Optional) Use syslog for logging. +# Defaults to $::os_service_default +# +# [*use_stderr*] +# (optional) Use stderr for logging +# Defaults to $::os_service_default +# +# [*syslog_log_facility*] +# (Optional) Syslog facility to receive log lines. +# Defaults to $::os_service_default +# +# [*log_dir*] +# (optional) Directory where logs should be stored. +# If set to boolean false, it will not log to any directory. +# Defaults to '/var/log/freezer'. +# +# [*log_file*] +# (optional) File where logs should be stored. +# Defaults to '/var/log/freezer/freezer.log' +# +# [*logging_context_format_string*] +# (optional) Format string to use for log messages with context. +# Defaults to $::os_service_default +# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\ +# [%(request_id)s %(user_identity)s] %(instance)s%(message)s' +# +# [*logging_default_format_string*] +# (optional) Format string to use for log messages without context. +# Defaults to $::os_service_default +# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\ +# [-] %(instance)s%(message)s' +# +# [*logging_debug_format_suffix*] +# (optional) Formatted data to append to log format when level is DEBUG. +# Defaults to $::os_service_default +# Example: '%(funcName)s %(pathname)s:%(lineno)d' +# +# [*logging_exception_prefix*] +# (optional) Prefix each line of exception output with this format. +# Defaults to $::os_service_default +# Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s' +# +# [*log_config_append*] +# (optional) The name of an additional logging configuration file. +# Defaults to $::os_service_default +# See https://docs.python.org/2/howto/logging.html +# +# [*default_log_levels*] +# (optional) Hash of logger (keys) and level (values) pairs. +# Defaults to $::os_service_default +# Example: +# { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN', +# 'qpid' => 'WARN', 'sqlalchemy' => 'WARN', 'suds' => 'INFO', +# 'oslo.messaging' => 'INFO', 'iso8601' => 'WARN', +# 'requests.packages.urllib3.connectionpool' => 'WARN', +# 'urllib3.connectionpool' => 'WARN', +# 'websocket' => 'WARN', 'freezermiddleware' => 'WARN', +# 'routes.middleware' => 'WARN', stevedore => 'WARN' } +# +# [*publish_errors*] +# (optional) Publish error events (boolean value). +# Defaults to $::os_service_default +# +# [*fatal_deprecations*] +# (optional) Make deprecations fatal (boolean value) +# Defaults to $::os_service_default +# +# [*instance_format*] +# (optional) If an instance is passed with the log message, format it +# like this (string value). +# Defaults to undef. +# Example: '[instance: %(uuid)s] ' +# +# [*instance_uuid_format*] +# (optional) If an instance UUID is passed with the log message, format +# it like this (string value). +# Defaults to $::os_service_default +# Example: instance_uuid_format='[instance: %(uuid)s] ' +# +# [*log_date_format*] +# (optional) Format string for %%(asctime)s in log records. +# Defaults to $::os_service_default +# Example: 'Y-%m-%d %H:%M:%S' + +class freezer::logging( + $use_syslog = $::os_service_default, + $use_stderr = $::os_service_default, + $syslog_log_facility = $::os_service_default, + $log_dir = '/var/log/freezer', + $log_file = '/var/log/freezer/freezer.log', + $debug = $::os_service_default, + $logging_context_format_string = $::os_service_default, + $logging_default_format_string = $::os_service_default, + $logging_debug_format_suffix = $::os_service_default, + $logging_exception_prefix = $::os_service_default, + $log_config_append = $::os_service_default, + $default_log_levels = $::os_service_default, + $publish_errors = $::os_service_default, + $fatal_deprecations = $::os_service_default, + $instance_format = $::os_service_default, + $instance_uuid_format = $::os_service_default, + $log_date_format = $::os_service_default, +) { + + oslo::log { 'freezer_config': + use_stderr => $use_stderr, + use_syslog => $use_syslog, + log_dir => $log_dir, + log_file => $log_file, + debug => $debug, + logging_context_format_string => $logging_context_format_string, + logging_default_format_string => $logging_default_format_string, + logging_debug_format_suffix => $logging_debug_format_suffix, + logging_exception_prefix => $logging_exception_prefix, + log_config_append => $log_config_append, + default_log_levels => $default_log_levels, + publish_errors => $publish_errors, + fatal_deprecations => $fatal_deprecations, + instance_format => $instance_format, + instance_uuid_format => $instance_uuid_format, + log_date_format => $log_date_format, + syslog_log_facility => $syslog_log_facility, + } +} diff --git a/manifests/params.pp b/manifests/params.pp new file mode 100644 index 0000000..766115a --- /dev/null +++ b/manifests/params.pp @@ -0,0 +1,16 @@ +# Parameters for puppet-freezer +# +class freezer::params { + include ::openstacklib::defaults + + case $::osfamily { + 'RedHat': { + } + 'Debian': { + } + default: { + fail("Unsupported osfamily: ${::osfamily} operatingsystem") + } + + } # Case $::osfamily +} diff --git a/manifests/policy.pp b/manifests/policy.pp new file mode 100644 index 0000000..868f239 --- /dev/null +++ b/manifests/policy.pp @@ -0,0 +1,41 @@ +# == Class: freezer::policy +# +# Configure the freezer policies +# +# === Parameters +# +# [*policies*] +# (optional) Set of policies to configure for freezer +# Example : +# { +# 'freezer-context_is_admin' => { +# 'key' => 'context_is_admin', +# 'value' => 'true' +# }, +# 'freezer-default' => { +# 'key' => 'default', +# 'value' => 'rule:admin_or_owner' +# } +# } +# Defaults to empty hash. +# +# [*policy_path*] +# (optional) Path to the nova policy.json file +# Defaults to /etc/freezer/policy.json +# +class freezer::policy ( + $policies = {}, + $policy_path = '/etc/freezer/policy.json', +) { + + validate_hash($policies) + + Openstacklib::Policy::Base { + file_path => $policy_path, + } + + create_resources('openstacklib::policy::base', $policies) + + oslo::policy { 'freezer_config': policy_file => $policy_path } + +} diff --git a/metadata.json b/metadata.json new file mode 100644 index 0000000..d1e994e --- /dev/null +++ b/metadata.json @@ -0,0 +1,36 @@ +{ + "name": "openstack-freezer", + "version": "0.0.1", + "author": "OpenStack Contributors", + "summary": "Puppet module for OpenStack Freezer", + "license": "Apache-2.0", + "source": "git://github.com/openstack/puppet-freezer.git", + "project_page": "https://launchpad.net/puppet-freezer", + "issues_url": "https://bugs.launchpad.net/puppet-freezer", + "description": "Installs and configures OpenStack Freezer.", + "operatingsystem_support": [ + { + "operatingsystem": "Debian", + "operatingsystemrelease": ["8"] + }, + { + "operatingsystem": "Fedora", + "operatingsystemrelease": ["21","22"] + }, + { + "operatingsystem": "RedHat", + "operatingsystemrelease": ["7"] + }, + { + "operatingsystem": "Ubuntu", + "operatingsystemrelease": ["14.04","16.04"] + } + ], + "dependencies": [ + { "name": "puppetlabs/inifile", "version_requirement": ">=1.0.0 <2.0.0" }, + { "name": "puppetlabs/stdlib", "version_requirement": ">= 4.2.0 <5.0.0" }, + { "name": "openstack/openstacklib", "version_requirement": ">=9.2.0 <10.0.0" }, + { "name": "openstack/keystone", "version_requirement": ">=9.2.0 <10.0.0" }, + { "name": "openstack/oslo", "version_requirement": ">=9.2.0 <10.0.0" } + ] +} diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..0e448c2 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,262 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'oslosphinx', + 'reno.sphinxext', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'puppet-freezer Release Notes' +copyright = u'2017, Puppet OpenStack Developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.0.1' +# The full version, including alpha/beta/rc tags. +release = '0.0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'puppet-freezerReleaseNotesdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'puppet-freezerReleaseNotes.tex', u'puppet-freezer Release Notes Documentation', + u'2017, Puppet OpenStack Developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'puppet-freezerreleasenotes', u'puppet-freezer Release Notes Documentation', + [u'2017, Puppet OpenStack Developers'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'puppet-freezerReleaseNotes', u'puppet-freezer Release Notes Documentation', + u'2017, Puppet OpenStack Developers', 'puppet-freezerReleaseNotes', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000..65f4ab9 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,18 @@ +======================================= +Welcome to freezer Release Notes! +======================================= + +Contents +======== + +.. toctree:: + :maxdepth: 2 + + unreleased + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..2334dd5 --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================== + Current Series Release Notes +============================== + + .. release-notes:: diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..8581d31 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,13 @@ +[metadata] +name = puppet-freezer +summary = Puppet module for OpenStack freezer +description-file = + README.md +author = Puppet Labs and OpenStack Contributors +author-email = openstack-dev@lists.openstack.org +home-page = http://docs.openstack.org/developer/puppet-openstack-guide +classifier = + Intended Audience :: Developers + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..70c2b3f --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/spec/classes/freezer_db_mysql_spec.rb b/spec/classes/freezer_db_mysql_spec.rb new file mode 100644 index 0000000..57fbcac --- /dev/null +++ b/spec/classes/freezer_db_mysql_spec.rb @@ -0,0 +1,73 @@ +require 'spec_helper' + +describe 'freezer::db::mysql' do + + let :pre_condition do + 'include mysql::server' + end + + let :required_params do + { :password => 'fooboozoo_default_password', } + end + + shared_examples_for 'freezer-db-mysql' do + context 'with only required params' do + let :params do + required_params + end + + it { is_expected.to contain_openstacklib__db__mysql('freezer').with( + :user => 'freezer', + :password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206', + :dbname => 'freezer', + :host => '127.0.0.1', + :charset => 'utf8', + :collate => 'utf8_general_ci', + )} + end + + context 'overriding allowed_hosts param to array' do + let :params do + { :allowed_hosts => ['127.0.0.1','%'] }.merge(required_params) + end + + it { is_expected.to contain_openstacklib__db__mysql('freezer').with( + :user => 'freezer', + :password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206', + :dbname => 'freezer', + :host => '127.0.0.1', + :charset => 'utf8', + :collate => 'utf8_general_ci', + :allowed_hosts => ['127.0.0.1','%'] + )} + end + + describe 'overriding allowed_hosts param to string' do + let :params do + { :allowed_hosts => '192.168.1.1' }.merge(required_params) + end + + it { is_expected.to contain_openstacklib__db__mysql('freezer').with( + :user => 'freezer', + :password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206', + :dbname => 'freezer', + :host => '127.0.0.1', + :charset => 'utf8', + :collate => 'utf8_general_ci', + :allowed_hosts => '192.168.1.1' + )} + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_behaves_like 'freezer-db-mysql' + end + end +end diff --git a/spec/classes/freezer_db_postgresql_spec.rb b/spec/classes/freezer_db_postgresql_spec.rb new file mode 100644 index 0000000..a182922 --- /dev/null +++ b/spec/classes/freezer_db_postgresql_spec.rb @@ -0,0 +1,37 @@ +require 'spec_helper' + +describe 'freezer::db::postgresql' do + + let :pre_condition do + 'include postgresql::server' + end + + let :required_params do + { :password => 'pw' } + end + + shared_examples_for 'freezer-db-postgresql' do + context 'with only required parameters' do + let :params do + required_params + end + + it { is_expected.to contain_postgresql__server__db('freezer').with( + :user => 'freezer', + :password => 'md5c530c33636c58ae83ca933f39319273e' + )} + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts({ :concat_basedir => '/var/lib/puppet/concat' })) + end + + it_behaves_like 'freezer-db-postgresql' + end + end +end diff --git a/spec/classes/freezer_db_spec.rb b/spec/classes/freezer_db_spec.rb new file mode 100644 index 0000000..e5f49ba --- /dev/null +++ b/spec/classes/freezer_db_spec.rb @@ -0,0 +1,117 @@ +require 'spec_helper' + +describe 'freezer::db' do + + shared_examples 'freezer::db' do + context 'with default parameters' do + it { is_expected.to contain_freezer_config('database/connection').with_value('sqlite:////var/lib/freezer/freezer.sqlite') } + it { is_expected.to contain_freezer_config('database/idle_timeout').with_value('') } + it { is_expected.to contain_freezer_config('database/min_pool_size').with_value('') } + it { is_expected.to contain_freezer_config('database/db_max_retries').with_value('') } + it { is_expected.to contain_freezer_config('database/max_retries').with_value('') } + it { is_expected.to contain_freezer_config('database/retry_interval').with_value('') } + it { is_expected.to contain_freezer_config('database/max_pool_size').with_value('') } + it { is_expected.to contain_freezer_config('database/max_overflow').with_value('') } + end + + context 'with specific parameters' do + let :params do + { :database_connection => 'mysql+pymysql://freezer:freezer@localhost/freezer', + :database_idle_timeout => '3601', + :database_min_pool_size => '2', + :database_db_max_retries => '-1', + :database_max_retries => '11', + :database_retry_interval => '11', + :database_max_pool_size => '11', + :database_max_overflow => '21', + } + end + + it { is_expected.to contain_freezer_config('database/connection').with_value('mysql+pymysql://freezer:freezer@localhost/freezer') } + it { is_expected.to contain_freezer_config('database/idle_timeout').with_value('3601') } + it { is_expected.to contain_freezer_config('database/min_pool_size').with_value('2') } + it { is_expected.to contain_freezer_config('database/db_max_retries').with_value('-1') } + it { is_expected.to contain_freezer_config('database/max_retries').with_value('11') } + it { is_expected.to contain_freezer_config('database/retry_interval').with_value('11') } + it { is_expected.to contain_freezer_config('database/max_pool_size').with_value('11') } + it { is_expected.to contain_freezer_config('database/max_overflow').with_value('21') } + end + + context 'with postgresql backend' do + let :params do + { :database_connection => 'postgresql://freezer:freezer@localhost/freezer', } + end + + it 'install the proper backend package' do + is_expected.to contain_package('python-psycopg2').with(:ensure => 'present') + end + + end + + context 'with MySQL-python library as backend package' do + let :params do + { :database_connection => 'mysql://freezer:freezer@localhost/freezer', } + end + + it { is_expected.to contain_package('python-mysqldb').with(:ensure => 'present') } + end + + context 'with incorrect database_connection string' do + let :params do + { :database_connection => 'foodb://freezer:freezer@localhost/freezer', } + end + + it_raises 'a Puppet::Error', /validate_re/ + end + + context 'with incorrect pymysql database_connection string' do + let :params do + { :database_connection => 'foo+pymysql://freezer:freezer@localhost/freezer', } + end + + it_raises 'a Puppet::Error', /validate_re/ + end + + end + + shared_examples_for 'freezer::db on Debian' do + context 'using pymysql driver' do + let :params do + { :database_connection => 'mysql+pymysql://freezer:freezer@localhost/freezer', } + end + + it 'install the proper backend package' do + is_expected.to contain_package('db_backend_package').with( + :ensure => 'present', + :name => 'python-pymysql', + :tag => 'openstack' + ) + end + end + end + + shared_examples_for 'freezer::db on RedHat' do + context 'using pymysql driver' do + let :params do + { :database_connection => 'mysql+pymysql://freezer:freezer@localhost/freezer', } + end + + it 'install the proper backend package' do + is_expected.not_to contain_package('db_backend_package') + end + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_configures 'freezer::db' + it_configures "freezer::db on #{facts[:osfamily]}" + end + end +end diff --git a/spec/classes/freezer_db_sync_spec.rb b/spec/classes/freezer_db_sync_spec.rb new file mode 100644 index 0000000..82ca0c0 --- /dev/null +++ b/spec/classes/freezer_db_sync_spec.rb @@ -0,0 +1,34 @@ +require 'spec_helper' + +describe 'freezer::db::sync' do + + shared_examples_for 'freezer-dbsync' do + + it 'runs freezer-db-sync' do + is_expected.to contain_exec('freezer-db-sync').with( + :command => 'freezer-manage db_sync ', + :path => [ '/bin', '/usr/bin', ], + :refreshonly => 'true', + :user => 'freezer', + :logoutput => 'on_failure' + ) + end + + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge(OSDefaults.get_facts({ + :os_workers => 8, + :concat_basedir => '/var/lib/puppet/concat' + })) + end + + it_configures 'freezer-dbsync' + end + end + +end diff --git a/spec/classes/freezer_keystone_auth_spec.rb b/spec/classes/freezer_keystone_auth_spec.rb new file mode 100644 index 0000000..94f270f --- /dev/null +++ b/spec/classes/freezer_keystone_auth_spec.rb @@ -0,0 +1,141 @@ +# +# Unit tests for freezer::keystone::auth +# + +require 'spec_helper' + +describe 'freezer::keystone::auth' do + shared_examples_for 'freezer-keystone-auth' do + context 'with default class parameters' do + let :params do + { :password => 'freezer_password', + :tenant => 'foobar' } + end + + it { is_expected.to contain_keystone_user('freezer').with( + :ensure => 'present', + :password => 'freezer_password', + ) } + + it { is_expected.to contain_keystone_user_role('freezer@foobar').with( + :ensure => 'present', + :roles => ['admin'] + )} + + it { is_expected.to contain_keystone_service('freezer::FIXME').with( + :ensure => 'present', + :description => 'freezer FIXME Service' + ) } + + it { is_expected.to contain_keystone_endpoint('RegionOne/freezer::FIXME').with( + :ensure => 'present', + :public_url => 'http://127.0.0.1:FIXME', + :admin_url => 'http://127.0.0.1:FIXME', + :internal_url => 'http://127.0.0.1:FIXME', + ) } + end + + context 'when overriding URL parameters' do + let :params do + { :password => 'freezer_password', + :public_url => 'https://10.10.10.10:80', + :internal_url => 'http://10.10.10.11:81', + :admin_url => 'http://10.10.10.12:81', } + end + + it { is_expected.to contain_keystone_endpoint('RegionOne/freezer::FIXME').with( + :ensure => 'present', + :public_url => 'https://10.10.10.10:80', + :internal_url => 'http://10.10.10.11:81', + :admin_url => 'http://10.10.10.12:81', + ) } + end + + context 'when overriding auth name' do + let :params do + { :password => 'foo', + :auth_name => 'freezery' } + end + + it { is_expected.to contain_keystone_user('freezery') } + it { is_expected.to contain_keystone_user_role('freezery@services') } + it { is_expected.to contain_keystone_service('freezer::FIXME') } + it { is_expected.to contain_keystone_endpoint('RegionOne/freezer::FIXME') } + end + + context 'when overriding service name' do + let :params do + { :service_name => 'freezer_service', + :auth_name => 'freezer', + :password => 'freezer_password' } + end + + it { is_expected.to contain_keystone_user('freezer') } + it { is_expected.to contain_keystone_user_role('freezer@services') } + it { is_expected.to contain_keystone_service('freezer_service::FIXME') } + it { is_expected.to contain_keystone_endpoint('RegionOne/freezer_service::FIXME') } + end + + context 'when disabling user configuration' do + + let :params do + { + :password => 'freezer_password', + :configure_user => false + } + end + + it { is_expected.not_to contain_keystone_user('freezer') } + it { is_expected.to contain_keystone_user_role('freezer@services') } + it { is_expected.to contain_keystone_service('freezer::FIXME').with( + :ensure => 'present', + :description => 'freezer FIXME Service' + ) } + + end + + context 'when disabling user and user role configuration' do + + let :params do + { + :password => 'freezer_password', + :configure_user => false, + :configure_user_role => false + } + end + + it { is_expected.not_to contain_keystone_user('freezer') } + it { is_expected.not_to contain_keystone_user_role('freezer@services') } + it { is_expected.to contain_keystone_service('freezer::FIXME').with( + :ensure => 'present', + :description => 'freezer FIXME Service' + ) } + + end + + context 'when using ensure absent' do + + let :params do + { + :password => 'freezer_password', + :ensure => 'absent' + } + end + + it { is_expected.to contain_keystone__resource__service_identity('freezer').with_ensure('absent') } + + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_behaves_like 'freezer-keystone-auth' + end + end +end diff --git a/spec/classes/freezer_keystone_authtoken_spec.rb b/spec/classes/freezer_keystone_authtoken_spec.rb new file mode 100644 index 0000000..29263d6 --- /dev/null +++ b/spec/classes/freezer_keystone_authtoken_spec.rb @@ -0,0 +1,147 @@ +require 'spec_helper' + +describe 'freezer::keystone::authtoken' do + + let :params do + { :password => 'secrete', } + end + + shared_examples 'freezer authtoken' do + + context 'with default parameters' do + + it 'configure keystone_authtoken' do + is_expected.to contain_freezer_config('keystone_authtoken/username').with_value('freezer') + is_expected.to contain_freezer_config('keystone_authtoken/password').with_value('secrete') + is_expected.to contain_freezer_config('keystone_authtoken/auth_url').with_value('http://localhost:35357') + is_expected.to contain_freezer_config('keystone_authtoken/project_name').with_value('services') + is_expected.to contain_freezer_config('keystone_authtoken/user_domain_name').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/project_domain_name').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/insecure').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/auth_section').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/auth_type').with_value('password') + is_expected.to contain_freezer_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000') + is_expected.to contain_freezer_config('keystone_authtoken/auth_version').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/cache').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/cafile').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/certfile').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/check_revocations_for_cached').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/delay_auth_decision').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/enforce_token_bind').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/hash_algorithms').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/http_connect_timeout').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/http_request_max_retries').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/include_service_catalog').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/keyfile').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_conn_get_timeout').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_dead_retry').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_maxsize').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_socket_timeout').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_unused_timeout').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_secret_key').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_security_strategy').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcache_use_advanced_pool').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/memcached_servers').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/region_name').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/revocation_cache_time').with_value('') + is_expected.to contain_freezer_config('keystone_authtoken/token_cache_time').with_value('') + end + end + + context 'when overriding parameters' do + before do + params.merge!({ + :auth_uri => 'https://10.0.0.1:9999/', + :username => 'myuser', + :password => 'mypasswd', + :auth_url => 'https://127.0.0.1:35357', + :project_name => 'service_project', + :user_domain_name => 'domainX', + :project_domain_name => 'domainX', + :insecure => false, + :auth_section => 'new_section', + :auth_type => 'password', + :auth_version => 'v3', + :cache => 'somevalue', + :cafile => '/opt/stack/data/cafile.pem', + :certfile => 'certfile.crt', + :check_revocations_for_cached => false, + :delay_auth_decision => false, + :enforce_token_bind => 'permissive', + :hash_algorithms => 'md5', + :http_connect_timeout => '300', + :http_request_max_retries => '3', + :include_service_catalog => true, + :keyfile => 'keyfile', + :memcache_pool_conn_get_timeout => '9', + :memcache_pool_dead_retry => '302', + :memcache_pool_maxsize => '11', + :memcache_pool_socket_timeout => '2', + :memcache_pool_unused_timeout => '61', + :memcache_secret_key => 'secret_key', + :memcache_security_strategy => 'ENCRYPT', + :memcache_use_advanced_pool => true, + :memcached_servers => ['memcached01:11211','memcached02:11211'], + :manage_memcache_package => true, + :region_name => 'region2', + :revocation_cache_time => '11', + :token_cache_time => '301', + }) + end + + it 'configure keystone_authtoken' do + is_expected.to contain_freezer_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/') + is_expected.to contain_freezer_config('keystone_authtoken/username').with_value(params[:username]) + is_expected.to contain_freezer_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true) + is_expected.to contain_freezer_config('keystone_authtoken/auth_url').with_value(params[:auth_url]) + is_expected.to contain_freezer_config('keystone_authtoken/project_name').with_value(params[:project_name]) + is_expected.to contain_freezer_config('keystone_authtoken/user_domain_name').with_value(params[:user_domain_name]) + is_expected.to contain_freezer_config('keystone_authtoken/project_domain_name').with_value(params[:project_domain_name]) + is_expected.to contain_freezer_config('keystone_authtoken/insecure').with_value(params[:insecure]) + is_expected.to contain_freezer_config('keystone_authtoken/auth_section').with_value(params[:auth_section]) + is_expected.to contain_freezer_config('keystone_authtoken/auth_type').with_value(params[:auth_type]) + is_expected.to contain_freezer_config('keystone_authtoken/auth_version').with_value(params[:auth_version]) + is_expected.to contain_freezer_config('keystone_authtoken/cache').with_value(params[:cache]) + is_expected.to contain_freezer_config('keystone_authtoken/cafile').with_value(params[:cafile]) + is_expected.to contain_freezer_config('keystone_authtoken/certfile').with_value(params[:certfile]) + is_expected.to contain_freezer_config('keystone_authtoken/check_revocations_for_cached').with_value(params[:check_revocations_for_cached]) + is_expected.to contain_freezer_config('keystone_authtoken/delay_auth_decision').with_value(params[:delay_auth_decision]) + is_expected.to contain_freezer_config('keystone_authtoken/enforce_token_bind').with_value(params[:enforce_token_bind]) + is_expected.to contain_freezer_config('keystone_authtoken/hash_algorithms').with_value(params[:hash_algorithms]) + is_expected.to contain_freezer_config('keystone_authtoken/http_connect_timeout').with_value(params[:http_connect_timeout]) + is_expected.to contain_freezer_config('keystone_authtoken/http_request_max_retries').with_value(params[:http_request_max_retries]) + is_expected.to contain_freezer_config('keystone_authtoken/include_service_catalog').with_value(params[:include_service_catalog]) + is_expected.to contain_freezer_config('keystone_authtoken/keyfile').with_value(params[:keyfile]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_conn_get_timeout').with_value(params[:memcache_pool_conn_get_timeout]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_dead_retry').with_value(params[:memcache_pool_dead_retry]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_maxsize').with_value(params[:memcache_pool_maxsize]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_socket_timeout').with_value(params[:memcache_pool_socket_timeout]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_pool_unused_timeout').with_value(params[:memcache_pool_unused_timeout]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_secret_key').with_value(params[:memcache_secret_key]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_security_strategy').with_value(params[:memcache_security_strategy]) + is_expected.to contain_freezer_config('keystone_authtoken/memcache_use_advanced_pool').with_value(params[:memcache_use_advanced_pool]) + is_expected.to contain_freezer_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211') + is_expected.to contain_freezer_config('keystone_authtoken/region_name').with_value(params[:region_name]) + is_expected.to contain_freezer_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time]) + is_expected.to contain_freezer_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time]) + end + + it 'installs python memcache package' do + is_expected.to contain_package('python-memcache') + end + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_configures 'freezer authtoken' + end + end + +end diff --git a/spec/classes/freezer_logging_spec.rb b/spec/classes/freezer_logging_spec.rb new file mode 100644 index 0000000..7036a84 --- /dev/null +++ b/spec/classes/freezer_logging_spec.rb @@ -0,0 +1,139 @@ +require 'spec_helper' + +describe 'freezer::logging' do + + let :params do + { + } + end + + let :log_params do + { + :logging_context_format_string => '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s', + :logging_default_format_string => '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s', + :logging_debug_format_suffix => '%(funcName)s %(pathname)s:%(lineno)d', + :logging_exception_prefix => '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s', + :log_config_append => '/etc/freezer/logging.conf', + :publish_errors => true, + :default_log_levels => { + 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN', + 'qpid' => 'WARN', 'sqlalchemy' => 'WARN', 'suds' => 'INFO', + 'iso8601' => 'WARN', + 'requests.packages.urllib3.connectionpool' => 'WARN' }, + :fatal_deprecations => true, + :instance_format => '[instance: %(uuid)s] ', + :instance_uuid_format => '[instance: %(uuid)s] ', + :log_date_format => '%Y-%m-%d %H:%M:%S', + :use_syslog => true, + :use_stderr => false, + :syslog_log_facility => 'LOG_FOO', + :log_dir => '/var/log', + :log_file => '/var/log/freezer.log', + :debug => true, + } + end + + shared_examples_for 'freezer-logging' do + + context 'with basic logging options and default settings' do + it_configures 'basic default logging settings' + end + + context 'with basic logging options and non-default settings' do + before { params.merge!( log_params ) } + it_configures 'basic non-default logging settings' + end + + context 'with extended logging options' do + before { params.merge!( log_params ) } + it_configures 'logging params set' + end + + context 'without extended logging options' do + it_configures 'logging params unset' + end + + end + + shared_examples 'basic default logging settings' do + it 'configures freezer logging settins with default values' do + is_expected.to contain_freezer_config('DEFAULT/use_syslog').with(:value => '') + is_expected.to contain_freezer_config('DEFAULT/use_stderr').with(:value => '') + is_expected.to contain_freezer_config('DEFAULT/syslog_log_facility').with(:value => '') + is_expected.to contain_freezer_config('DEFAULT/log_dir').with(:value => '/var/log/freezer') + is_expected.to contain_freezer_config('DEFAULT/log_file').with(:value => '/var/log/freezer/freezer.log') + is_expected.to contain_freezer_config('DEFAULT/debug').with(:value => '') + end + end + + shared_examples 'basic non-default logging settings' do + it 'configures freezer logging settins with non-default values' do + is_expected.to contain_freezer_config('DEFAULT/use_syslog').with(:value => 'true') + is_expected.to contain_freezer_config('DEFAULT/use_stderr').with(:value => 'false') + is_expected.to contain_freezer_config('DEFAULT/syslog_log_facility').with(:value => 'LOG_FOO') + is_expected.to contain_freezer_config('DEFAULT/log_dir').with(:value => '/var/log') + is_expected.to contain_freezer_config('DEFAULT/log_file').with(:value => '/var/log/freezer.log') + is_expected.to contain_freezer_config('DEFAULT/debug').with(:value => 'true') + end + end + + shared_examples_for 'logging params set' do + it 'enables logging params' do + is_expected.to contain_freezer_config('DEFAULT/logging_context_format_string').with_value( + '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s') + + is_expected.to contain_freezer_config('DEFAULT/logging_default_format_string').with_value( + '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s') + + is_expected.to contain_freezer_config('DEFAULT/logging_debug_format_suffix').with_value( + '%(funcName)s %(pathname)s:%(lineno)d') + + is_expected.to contain_freezer_config('DEFAULT/logging_exception_prefix').with_value( + '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s') + + is_expected.to contain_freezer_config('DEFAULT/log_config_append').with_value( + '/etc/freezer/logging.conf') + is_expected.to contain_freezer_config('DEFAULT/publish_errors').with_value( + true) + + is_expected.to contain_freezer_config('DEFAULT/default_log_levels').with_value( + 'amqp=WARN,amqplib=WARN,boto=WARN,iso8601=WARN,qpid=WARN,requests.packages.urllib3.connectionpool=WARN,sqlalchemy=WARN,suds=INFO') + + is_expected.to contain_freezer_config('DEFAULT/fatal_deprecations').with_value( + true) + + is_expected.to contain_freezer_config('DEFAULT/instance_format').with_value( + '[instance: %(uuid)s] ') + + is_expected.to contain_freezer_config('DEFAULT/instance_uuid_format').with_value( + '[instance: %(uuid)s] ') + + is_expected.to contain_freezer_config('DEFAULT/log_date_format').with_value( + '%Y-%m-%d %H:%M:%S') + end + end + + + shared_examples_for 'logging params unset' do + [ :logging_context_format_string, :logging_default_format_string, + :logging_debug_format_suffix, :logging_exception_prefix, + :log_config_append, :publish_errors, + :default_log_levels, :fatal_deprecations, + :instance_format, :instance_uuid_format, + :log_date_format, ].each { |param| + it { is_expected.to contain_freezer_config("DEFAULT/#{param}").with_value('') } + } + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_behaves_like 'freezer-logging' + end + end +end diff --git a/spec/classes/freezer_policy_spec.rb b/spec/classes/freezer_policy_spec.rb new file mode 100644 index 0000000..c53d40e --- /dev/null +++ b/spec/classes/freezer_policy_spec.rb @@ -0,0 +1,36 @@ +require 'spec_helper' + +describe 'freezer::policy' do + shared_examples_for 'freezer-policies' do + let :params do + { + :policy_path => '/etc/freezer/policy.json', + :policies => { + 'context_is_admin' => { + 'key' => 'context_is_admin', + 'value' => 'foo:bar' + } + } + } + end + + it 'set up the policies' do + is_expected.to contain_openstacklib__policy__base('context_is_admin').with({ + :key => 'context_is_admin', + :value => 'foo:bar' + }) + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_behaves_like 'freezer-policies' + end + end +end diff --git a/spec/shared_examples.rb b/spec/shared_examples.rb new file mode 100644 index 0000000..fec0eac --- /dev/null +++ b/spec/shared_examples.rb @@ -0,0 +1,5 @@ +shared_examples_for "a Puppet::Error" do |description| + it "with message matching #{description.inspect}" do + expect { is_expected.to have_class_count(1) }.to raise_error(Puppet::Error, description) + end +end diff --git a/spec/unit/provider/freezer_config/ini_setting_spec.rb b/spec/unit/provider/freezer_config/ini_setting_spec.rb new file mode 100644 index 0000000..c7b137d --- /dev/null +++ b/spec/unit/provider/freezer_config/ini_setting_spec.rb @@ -0,0 +1,68 @@ +# +# these tests are a little concerning b/c they are hacking around the +# modulepath, so these tests will not catch issues that may eventually arise +# related to loading these plugins. +# I could not, for the life of me, figure out how to programatcally set the modulepath +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + '..', + 'fixtures', + 'modules', + 'inifile', + 'lib') +) +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + '..', + 'fixtures', + 'modules', + 'openstacklib', + 'lib') +) +require 'spec_helper' +provider_class = Puppet::Type.type(:freezer_config).provider(:ini_setting) +describe provider_class do + + it 'should default to the default setting when no other one is specified' do + resource = Puppet::Type::Freezer_config.new( + {:name => 'DEFAULT/foo', :value => 'bar'} + ) + provider = provider_class.new(resource) + expect(provider.section).to eq('DEFAULT') + expect(provider.setting).to eq('foo') + end + + it 'should allow setting to be set explicitly' do + resource = Puppet::Type::Freezer_config.new( + {:name => 'dude/foo', :value => 'bar'} + ) + provider = provider_class.new(resource) + expect(provider.section).to eq('dude') + expect(provider.setting).to eq('foo') + end + + it 'should ensure absent when is specified as a value' do + resource = Puppet::Type::Freezer_config.new( + {:name => 'dude/foo', :value => ''} + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + + it 'should ensure absent when value matches ensure_absent_val' do + resource = Puppet::Type::Freezer_config.new( + {:name => 'dude/foo', :value => 'foo', :ensure_absent_val => 'foo' } + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + +end diff --git a/spec/unit/type/freezer_config_spec.rb b/spec/unit/type/freezer_config_spec.rb new file mode 100644 index 0000000..db01c3f --- /dev/null +++ b/spec/unit/type/freezer_config_spec.rb @@ -0,0 +1,64 @@ +require 'puppet' +require 'puppet/type/freezer_config' +describe 'Puppet::Type.type(:freezer_config)' do + before :each do + @freezer_config = Puppet::Type.type(:freezer_config).new(:name => 'DEFAULT/foo', :value => 'bar') + end + + it 'should require a name' do + expect { + Puppet::Type.type(:freezer_config).new({}) + }.to raise_error(Puppet::Error, 'Title or name must be provided') + end + + it 'should not expect a name with whitespace' do + expect { + Puppet::Type.type(:freezer_config).new(:name => 'f oo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should fail when there is no section' do + expect { + Puppet::Type.type(:freezer_config).new(:name => 'foo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should not require a value when ensure is absent' do + Puppet::Type.type(:freezer_config).new(:name => 'DEFAULT/foo', :ensure => :absent) + end + + it 'should accept a valid value' do + @freezer_config[:value] = 'bar' + expect(@freezer_config[:value]).to eq('bar') + end + + it 'should not accept a value with whitespace' do + @freezer_config[:value] = 'b ar' + expect(@freezer_config[:value]).to eq('b ar') + end + + it 'should accept valid ensure values' do + @freezer_config[:ensure] = :present + expect(@freezer_config[:ensure]).to eq(:present) + @freezer_config[:ensure] = :absent + expect(@freezer_config[:ensure]).to eq(:absent) + end + + it 'should not accept invalid ensure values' do + expect { + @freezer_config[:ensure] = :latest + }.to raise_error(Puppet::Error, /Invalid value/) + end + + it 'should autorequire the package that install the file' do + catalog = Puppet::Resource::Catalog.new + package = Puppet::Type.type(:package).new(:name => 'freezer') + catalog.add_resource package, @freezer_config + dependency = @freezer_config.autorequire + expect(dependency.size).to eq(1) + expect(dependency[0].target).to eq(@freezer_config) + expect(dependency[0].source).to eq(package) + end + + +end diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..bedd666 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,4 @@ +# this is required for the docs build jobs +sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 +oslosphinx>=2.5.0 # Apache-2.0 +reno>=0.1.1 # Apache-2.0 diff --git a/tests/init.pp b/tests/init.pp new file mode 100644 index 0000000..8419274 --- /dev/null +++ b/tests/init.pp @@ -0,0 +1,12 @@ +# The baseline for module testing used by Puppet Labs is that each manifest +# should have a corresponding test manifest that declares that class or defined +# type. +# +# Tests are then run by using puppet apply --noop (to check for compilation +# errors and view a log of events) or by fully applying the test in a virtual +# environment (to compare the resulting system state to the desired state). +# +# Learn more about module testing here: +# http://docs.puppetlabs.com/guides/tests_smoke.html +# +include ::freezer diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..aea06c8 --- /dev/null +++ b/tox.ini @@ -0,0 +1,8 @@ +[tox] +minversion = 1.6 +skipsdist = True +envlist = releasenotes + +[testenv:releasenotes] +deps = -rtest-requirements.txt +commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html