openstack
/
puppet-watcher
Code Issues Proposed changes

puppet-watcher: Initial commit 

This is the initial commit for puppet-watcher.
It has been automatically generated using cookiecutter[1] and msync[2]

[1] https://github.com/openstack/puppet-openstack-cookiecutter
[2] https://github.com/openstack/puppet-modulesync-configs

Change-Id: I72a2df77b202c994b24887062544918903f3631b
This commit is contained in:
Daniel Pawlik 2016-05-31 11:37:25 +00:00
parent 23f5e1c6b1
commit 812594b6d9
35 changed files with 1505 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.gitignore vendored Normal file
View File

@ -0,0 +1,11 @@
pkg/
Gemfile.lock
vendor/
spec/fixtures/
.vagrant/
.bundle/
coverage/
.idea/
*.swp
*.iml
openstack/

21
Gemfile Normal file
View File

@ -0,0 +1,21 @@
source ENV['GEM_SOURCE'] || "https://rubygems.org"
group :development, :test, :system_tests do
gem 'puppet-openstack_spec_helper',
:git => 'https://git.openstack.org/openstack/puppet-openstack_spec_helper',
:require => 'false'
end
if facterversion = ENV['FACTER_GEM_VERSION']
gem 'facter', facterversion, :require => false
else
gem 'facter', :require => false
end
if puppetversion = ENV['PUPPET_GEM_VERSION']
gem 'puppet', puppetversion, :require => false
else
gem 'puppet', :require => false
end
# vim:ft=ruby

13
LICENSE Normal file
View File

@ -0,0 +1,13 @@
Copyright 2016 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.

78
README.md Normal file
View File

@ -0,0 +1,78 @@
watcher
=======
#### Table of Contents
1. [Overview - What is the watcher module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with watcher](#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 watcher 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 Watcher service for OpenStack.
Module Description
------------------
The watcher module is a thorough attempt to make Puppet capable of managing the entirety of watcher. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the watcher module to assist in manipulation of configuration files.
Setup
-----
**What the watcher module affects**
* [Watcher](https://wiki.openstack.org/wiki/Watcher), the Watcher service for OpenStack.
### Installing watcher
watcher is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install watcher with:
puppet module install openstack/watcher
### Beginning with watcher
To utilize the watcher module's functionality you will need to declare multiple resources.
Implementation
--------------
### watcher
watcher is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Limitations
------------
* All the watcher types use the CLI tools and so need to be ran on the watcher 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.
* https://wiki.openstack.org/wiki/Puppet
Contributors
------------
* https://github.com/openstack/puppet-watcher/graphs/contributors

1
Rakefile Normal file
View File

@ -0,0 +1 @@
require 'puppet-openstack_spec_helper/rake_tasks'

10
lib/puppet/provider/watcher_config/ini_setting.rb Normal file
View File

@ -0,0 +1,10 @@
Puppet::Type.type(:watcher_config).provide(
:ini_setting,
:parent => Puppet::Type.type(:openstack_config).provider(:ini_setting)
) do
def self.file_path
'/etc/watcher/watcher.conf'
end
end

53
lib/puppet/type/watcher_config.rb Normal file
View File

@ -0,0 +1,53 @@
Puppet::Type.newtype(:watcher_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from watcher.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('<SERVICE DEFAULT>')
end
autorequire(:package) do
'watcher'
end
end

30
manifests/config.pp Normal file
View File

@ -0,0 +1,30 @@
# == Class: watcher::config
#
# This class is used to manage arbitrary watcher configurations.
#
# === Parameters
#
# [*watcher_config*]
# (optional) Allow configuration of arbitrary watcher configurations.
# The value is an hash of watcher_config resources. Example:
# { 'DEFAULT/foo' => { value => 'fooValue'},
# 'DEFAULT/bar' => { value => 'barValue'}
# }
# In yaml format, Example:
# watcher_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 watcher::config (
$watcher_config = {},
) {
validate_hash($watcher_config)
create_resources('watcher_config', $watcher_config)
}

58
manifests/db.pp Normal file
View File

@ -0,0 +1,58 @@
# == Class: watcher::db
#
# Configure the watcher database
#
# === Parameters
#
# [*database_connection*]
# (Optional) Url used to connect to database.
# Defaults to "sqlite:////var/lib/watcher/watcher.sqlite".
#
# [*database_idle_timeout*]
# (Optional) Timeout when db connections should be reaped.
# 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 watcher::db (
$database_connection = 'sqlite:////var/lib/watcher/watcher.sqlite',
$database_idle_timeout = $::os_service_default,
$database_min_pool_size = $::os_service_default,
$database_max_pool_size = $::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 { 'watcher_config':
connection => $database_connection,
idle_timeout => $database_idle_timeout,
min_pool_size => $database_min_pool_size,
max_retries => $database_max_retries,
retry_interval => $database_retry_interval,
max_pool_size => $database_max_pool_size,
max_overflow => $database_max_overflow,
}
}

69
manifests/db/mysql.pp Normal file
View File

@ -0,0 +1,69 @@
# The watcher::db::mysql class implements mysql backend for watcher
#
# This class can be used to create tables, users and grant
# privilege for a mysql watcher database.
#
# == parameters
#
# [*password*]
# (Mandatory) Password to connect to the database.
# Defaults to 'false'.
#
# [*dbname*]
# (Optional) Name of the database.
# Defaults to 'watcher'.
#
# [*user*]
# (Optional) User to connect to the database.
# Defaults to 'watcher'.
#
# [*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 watcher::db::mysql(
$password,
$dbname = 'watcher',
$user = 'watcher',
$host = '127.0.0.1',
$charset = 'utf8',
$collate = 'utf8_general_ci',
$allowed_hosts = undef
) {
validate_string($password)
::openstacklib::db::mysql { 'watcher':
user => $user,
password_hash => mysql_password($password),
dbname => $dbname,
host => $host,
charset => $charset,
collate => $collate,
allowed_hosts => $allowed_hosts,
}
::Openstacklib::Db::Mysql['watcher'] ~> Exec<| title == 'watcher-manage db_sync' |>
}

55
manifests/db/postgresql.pp Normal file
View File

@ -0,0 +1,55 @@
# == Class: watcher::db::postgresql
#
# Class that configures postgresql for watcher
# Requires the Puppetlabs postgresql module.
#
# === Parameters
#
# [*password*]
# (Required) Password to connect to the database.
#
# [*dbname*]
# (Optional) Name of the database.
# Defaults to 'watcher'.
#
# [*user*]
# (Optional) User to connect to the database.
# Defaults to 'watcher'.
#
# [*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 watcher::db::postgresql(
$password,
$dbname = 'watcher',
$user = 'watcher',
$encoding = undef,
$privileges = 'ALL',
) {
Class['watcher::db::postgresql'] -> Service<| title == 'watcher' |>
::openstacklib::db::postgresql { 'watcher':
password_hash => postgresql_password($user, $password),
dbname => $dbname,
user => $user,
encoding => $encoding,
privileges => $privileges,
}
::Openstacklib::Db::Postgresql['watcher'] ~> Exec<| title == 'watcher-manage db_sync' |>
}

23
manifests/db/sync.pp Normal file
View File

@ -0,0 +1,23 @@
#
# Class to execute watcher-manage db_sync
#
# == Parameters
#
# [*extra_params*]
# (optional) String of extra command line parameters to append
# to the watcher-dbsync command.
# Defaults to undef
#
class watcher::db::sync(
$extra_params = undef,
) {
exec { 'watcher-db-sync':
command => "watcher-manage db_sync ${extra_params}",
path => '/usr/bin',
user => 'watcher',
refreshonly => true,
subscribe => [Package['watcher'], Watcher_config['database/connection']],
}
Exec['watcher-manage db_sync'] ~> Service<| title == 'watcher' |>
}

14
manifests/init.pp Normal file
View File

@ -0,0 +1,14 @@
# == Class: watcher
#
# Full description of class watcher here.
#
# === Parameters
#
# [*sample_parameter*]
# Explanation of what this parameter affects and what it defaults to.
#
class watcher {
include ::watcher::params
}

96
manifests/keystone/auth.pp Normal file
View File

@ -0,0 +1,96 @@
# == Class: watcher::keystone::auth
#
# Configures watcher user, service and endpoint in Keystone.
#
# === Parameters
#
# [*password*]
# (required) Password for watcher user.
#
# [*auth_name*]
# Username for watcher service. Defaults to 'watcher'.
#
# [*email*]
# Email for watcher user. Defaults to 'watcher@localhost'.
#
# [*tenant*]
# Tenant for watcher user. Defaults to 'services'.
#
# [*configure_endpoint*]
# Should watcher 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 auth_name.
#
# [*service_description*]
# (optional) Description of the service.
# Default to 'watcher API Service'
#
# [*public_url*]
# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:9322')
# This url should *not* contain any trailing '/'.
#
# [*admin_url*]
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:9322')
# This url should *not* contain any trailing '/'.
#
# [*internal_url*]
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:9322')
#
class watcher::keystone::auth (
$password,
$auth_name = 'watcher',
$email = 'watcher@localhost',
$tenant = 'services',
$configure_endpoint = true,
$configure_user = true,
$configure_user_role = true,
$service_name = undef,
$service_description = 'Infrastructure Optimization service',
$service_type = 'infra-optim',
$region = 'RegionOne',
$public_url = 'http://127.0.0.1:9322',
$admin_url = 'http://127.0.0.1:9322',
$internal_url = 'http://127.0.0.1:9322',
) {
$real_service_name = pick($service_name, $auth_name)
if $configure_user_role {
Keystone_user_role["${auth_name}@${tenant}"] ~> Service <| name == 'watcher-server' |>
}
Keystone_endpoint["${region}/${real_service_name}::${service_type}"] ~> Service <| name == 'watcher-server' |>
keystone::resource::service_identity { 'watcher':
configure_user => $configure_user,
configure_user_role => $configure_user_role,
configure_endpoint => $configure_endpoint,
service_name => $real_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,
}
}

135
manifests/logging.pp Normal file
View File

@ -0,0 +1,135 @@
# Class watcher::logging
#
# watcher 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/watcher'.
#
# [*log_file*]
# (optional) File where logs should be stored.
# Defaults to '/var/log/watcher/watcher.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', 'watchermiddleware' => '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 watcher::logging(
$use_syslog = $::os_service_default,
$use_stderr = $::os_service_default,
$syslog_log_facility = $::os_service_default,
$log_dir = '/var/log/watcher',
$log_file = '/var/log/watcher/watcher.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 { 'watcher_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,
}
}

15
manifests/params.pp Normal file
View File

@ -0,0 +1,15 @@
# Parameters for puppet-watcher
#
class watcher::params {
case $::osfamily {
'RedHat': {
}
'Debian': {
}
default: {
fail("Unsupported osfamily: ${::osfamily} operatingsystem")
}
} # Case $::osfamily
}

41
manifests/policy.pp Normal file
View File

@ -0,0 +1,41 @@
# == Class: watcher::policy
#
# Configure the watcher policies
#
# === Parameters
#
# [*policies*]
# (optional) Set of policies to configure for watcher
# Example :
# {
# 'watcher-context_is_admin' => {
# 'key' => 'context_is_admin',
# 'value' => 'true'
# },
# 'watcher-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/watcher/policy.json
#
class watcher::policy (
$policies = {},
$policy_path = '/etc/watcher/policy.json',
) {
validate_hash($policies)
Openstacklib::Policy::Base {
file_path => $policy_path,
}
create_resources('openstacklib::policy::base', $policies)
oslo::policy { 'watcher_config': policy_file => $policy_path }
}

35
metadata.json Normal file
View File

@ -0,0 +1,35 @@
{
"name": "puppet-watcher",
"version": "0.0.1",
"author": "OpenStack Contributors",
"summary": "Puppet module for OpenStack Watcher",
"license": "Apache-2.0",
"source": "git://github.com/openstack/puppet-watcher.git",
"project_page": "https://launchpad.net/puppet-watcher",
"issues_url": "https://bugs.launchpad.net/puppet-watcher",
"description": "Installs and configures OpenStack Watcher.",
"operatingsystem_support": [
{
"operatingsystem": "Debian",
"operatingsystemrelease": ["8"]
},
{
"operatingsystem": "Fedora",
"operatingsystemrelease": ["21","22"]
},
{
"operatingsystem": "RedHat",
"operatingsystemrelease": ["7"]
},
{
"operatingsystem": "Ubuntu",
"operatingsystemrelease": ["14.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": ">=8.0.0 <9.0.0" },
{ "name": "openstack/oslo", "version_requirement": "<9.0.0" }
]
}

11
spec/acceptance/nodesets/centos-70-x64.yml Normal file
View File

@ -0,0 +1,11 @@
HOSTS:
centos-server-70-x64:
roles:
- master
platform: el-7-x86_64
box: puppetlabs/centos-7.0-64-nocm
box_url: https://vagrantcloud.com/puppetlabs/centos-7.0-64-nocm
hypervisor: vagrant
CONFIG:
log_level: debug
type: foss

10
spec/acceptance/nodesets/default.yml Normal file
View File

@ -0,0 +1,10 @@
HOSTS:
ubuntu-server-14.04-amd64:
roles:
- master
platform: ubuntu-14.04-amd64
box: puppetlabs/ubuntu-14.04-64-nocm
box_url: https://vagrantcloud.com/puppetlabs/ubuntu-14.04-64-nocm
hypervisor: vagrant
CONFIG:
type: foss

10
spec/acceptance/nodesets/nodepool-centos7.yml Normal file
View File

@ -0,0 +1,10 @@
HOSTS:
centos-70-x64:
roles:
- master
platform: el-7-x86_64
hypervisor: none
ip: 127.0.0.1
CONFIG:
type: foss
set_env: false

10
spec/acceptance/nodesets/nodepool-trusty.yml Normal file
View File

@ -0,0 +1,10 @@
HOSTS:
ubuntu-14.04-amd64:
roles:
- master
platform: ubuntu-14.04-amd64
hypervisor: none
ip: 127.0.0.1
CONFIG:
type: foss
set_env: false

11
spec/acceptance/nodesets/ubuntu-server-1404-x64.yml Normal file
View File

@ -0,0 +1,11 @@
HOSTS:
ubuntu-server-14.04-amd64:
roles:
- master
platform: ubuntu-14.04-amd64
box: puppetlabs/ubuntu-14.04-64-nocm
box_url: https://vagrantcloud.com/puppetlabs/ubuntu-14.04-64-nocm
hypervisor: vagrant
CONFIG:
log_level: debug
type: foss

73
spec/classes/watcher_db_mysql_spec.rb Normal file
View File

@ -0,0 +1,73 @@
require 'spec_helper'
describe 'watcher::db::mysql' do
let :pre_condition do
'include mysql::server'
end
let :required_params do
{ :password => 'fooboozoo_default_password', }
end
shared_examples_for 'watcher-db-mysql' do
context 'with only required params' do
let :params do
required_params
end
it { is_expected.to contain_openstacklib__db__mysql('watcher').with(
:user => 'watcher',
:password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206',
:dbname => 'watcher',
: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('watcher').with(
:user => 'watcher',
:password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206',
:dbname => 'watcher',
: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('watcher').with(
:user => 'watcher',
:password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206',
:dbname => 'watcher',
: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 'watcher-db-mysql'
end
end
end

37
spec/classes/watcher_db_postgresql_spec.rb Normal file
View File

@ -0,0 +1,37 @@
require 'spec_helper'
describe 'watcher::db::postgresql' do
let :pre_condition do
'include postgresql::server'
end
let :required_params do
{ :password => 'pw' }
end
shared_examples_for 'watcher-db-postgresql' do
context 'with only required parameters' do
let :params do
required_params
end
it { is_expected.to contain_postgresql__server__db('watcher').with(
:user => 'watcher',
:password => 'md5bb8678c96047fcce9b899ad5da021642'
)}
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 'watcher-db-postgresql'
end
end
end

114
spec/classes/watcher_db_spec.rb Normal file
View File

@ -0,0 +1,114 @@
require 'spec_helper'
describe 'watcher::db' do
shared_examples 'watcher::db' do
context 'with default parameters' do
it { is_expected.to contain_watcher_config('database/connection').with_value('sqlite:////var/lib/watcher/watcher.sqlite') }
it { is_expected.to contain_watcher_config('database/idle_timeout').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_watcher_config('database/min_pool_size').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_watcher_config('database/max_retries').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_watcher_config('database/retry_interval').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_watcher_config('database/max_pool_size').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_watcher_config('database/max_overflow').with_value('<SERVICE DEFAULT>') }
end
context 'with specific parameters' do
let :params do
{ :database_connection => 'mysql+pymysql://watcher:watcher@localhost/watcher',
:database_idle_timeout => '3601',
:database_min_pool_size => '2',
:database_max_retries => '11',
:database_retry_interval => '11',
:database_max_pool_size => '11',
:database_max_overflow => '21',
}
end
it { is_expected.to contain_watcher_config('database/connection').with_value('mysql+pymysql://watcher:watcher@localhost/watcher') }
it { is_expected.to contain_watcher_config('database/idle_timeout').with_value('3601') }
it { is_expected.to contain_watcher_config('database/min_pool_size').with_value('2') }
it { is_expected.to contain_watcher_config('database/max_retries').with_value('11') }
it { is_expected.to contain_watcher_config('database/retry_interval').with_value('11') }
it { is_expected.to contain_watcher_config('database/max_pool_size').with_value('11') }
it { is_expected.to contain_watcher_config('database/max_overflow').with_value('21') }
end
context 'with postgresql backend' do
let :params do
{ :database_connection => 'postgresql://watcher:watcher@localhost/watcher', }
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://watcher:watcher@localhost/watcher', }
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://watcher:watcher@localhost/watcher', }
end
it_raises 'a Puppet::Error', /validate_re/
end
context 'with incorrect pymysql database_connection string' do
let :params do
{ :database_connection => 'foo+pymysql://watcher:watcher@localhost/watcher', }
end
it_raises 'a Puppet::Error', /validate_re/
end
end
shared_examples_for 'watcher::db on Debian' do
context 'using pymysql driver' do
let :params do
{ :database_connection => 'mysql+pymysql://watcher:watcher@localhost/watcher', }
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 'watcher::db on RedHat' do
context 'using pymysql driver' do
let :params do
{ :database_connection => 'mysql+pymysql://watcher:watcher@localhost/watcher', }
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 'watcher::db'
it_configures "watcher::db on #{facts[:osfamily]}"
end
end
end

128
spec/classes/watcher_keystone_auth_spec.rb Normal file
View File

@ -0,0 +1,128 @@
#
# Unit tests for watcher::keystone::auth
#
require 'spec_helper'
describe 'watcher::keystone::auth' do
shared_examples_for 'watcher-keystone-auth' do
context 'with default class parameters' do
let :params do
{ :password => 'watcher_password',
:tenant => 'foobar' }
end
it { is_expected.to contain_keystone_user('watcher').with(
:ensure => 'present',
:password => 'watcher_password',
) }
it { is_expected.to contain_keystone_user_role('watcher@foobar').with(
:ensure => 'present',
:roles => ['admin']
)}
it { is_expected.to contain_keystone_service('watcher::infra-optim').with(
:ensure => 'present',
:description => 'Infrastructure Optimization service'
) }
it { is_expected.to contain_keystone_endpoint('RegionOne/watcher::infra-optim').with(
:ensure => 'present',
:public_url => 'http://127.0.0.1:9322',
:admin_url => 'http://127.0.0.1:9322',
:internal_url => 'http://127.0.0.1:9322',
) }
end
context 'when overriding URL parameters' do
let :params do
{ :password => 'watcher_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/watcher::infra-optim').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 => 'watchery' }
end
it { is_expected.to contain_keystone_user('watchery') }
it { is_expected.to contain_keystone_user_role('watchery@services') }
it { is_expected.to contain_keystone_service('watchery::infra-optim') }
it { is_expected.to contain_keystone_endpoint('RegionOne/watchery::infra-optim') }
end
context 'when overriding service name' do
let :params do
{ :service_name => 'watcher_service',
:auth_name => 'watcher',
:password => 'watcher_password' }
end
it { is_expected.to contain_keystone_user('watcher') }
it { is_expected.to contain_keystone_user_role('watcher@services') }
it { is_expected.to contain_keystone_service('watcher_service::infra-optim') }
it { is_expected.to contain_keystone_endpoint('RegionOne/watcher_service::infra-optim') }
end
context 'when disabling user configuration' do
let :params do
{
:password => 'watcher_password',
:configure_user => false
}
end
it { is_expected.not_to contain_keystone_user('watcher') }
it { is_expected.to contain_keystone_user_role('watcher@services') }
it { is_expected.to contain_keystone_service('watcher::infra-optim').with(
:ensure => 'present',
:description => 'Infrastructure Optimization service'
) }
end
context 'when disabling user and user role configuration' do
let :params do
{
:password => 'watcher_password',
:configure_user => false,
:configure_user_role => false
}
end
it { is_expected.not_to contain_keystone_user('watcher') }
it { is_expected.not_to contain_keystone_user_role('watcher@services') }
it { is_expected.to contain_keystone_service('watcher::infra-optim').with(
:ensure => 'present',
:description => 'Infrastructure Optimization service'
) }
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 'watcher-keystone-auth'
end
end
end

139
spec/classes/watcher_logging_spec.rb Normal file
View File

@ -0,0 +1,139 @@
require 'spec_helper'
describe 'watcher::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/watcher/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/watcher.log',
:debug => true,
}
end
shared_examples_for 'watcher-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 watcher logging settins with default values' do
is_expected.to contain_watcher_config('DEFAULT/use_syslog').with(:value => '<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('DEFAULT/use_stderr').with(:value => '<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('DEFAULT/syslog_log_facility').with(:value => '<SERVICE DEFAULT>')
is_expected.to contain_watcher_config('DEFAULT/log_dir').with(:value => '/var/log/watcher')
is_expected.to contain_watcher_config('DEFAULT/log_file').with(:value => '/var/log/watcher/watcher.log')
is_expected.to contain_watcher_config('DEFAULT/debug').with(:value => '<SERVICE DEFAULT>')
end
end
shared_examples 'basic non-default logging settings' do
it 'configures watcher logging settins with non-default values' do
is_expected.to contain_watcher_config('DEFAULT/use_syslog').with(:value => 'true')
is_expected.to contain_watcher_config('DEFAULT/use_stderr').with(:value => 'false')
is_expected.to contain_watcher_config('DEFAULT/syslog_log_facility').with(:value => 'LOG_FOO')
is_expected.to contain_watcher_config('DEFAULT/log_dir').with(:value => '/var/log')
is_expected.to contain_watcher_config('DEFAULT/log_file').with(:value => '/var/log/watcher.log')
is_expected.to contain_watcher_config('DEFAULT/debug').with(:value => 'true')
end
end
shared_examples_for 'logging params set' do
it 'enables logging params' do
is_expected.to contain_watcher_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_watcher_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_watcher_config('DEFAULT/logging_debug_format_suffix').with_value(
'%(funcName)s %(pathname)s:%(lineno)d')
is_expected.to contain_watcher_config('DEFAULT/logging_exception_prefix').with_value(
'%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s')
is_expected.to contain_watcher_config('DEFAULT/log_config_append').with_value(
'/etc/watcher/logging.conf')
is_expected.to contain_watcher_config('DEFAULT/publish_errors').with_value(
true)
is_expected.to contain_watcher_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_watcher_config('DEFAULT/fatal_deprecations').with_value(
true)
is_expected.to contain_watcher_config('DEFAULT/instance_format').with_value(
'[instance: %(uuid)s] ')
is_expected.to contain_watcher_config('DEFAULT/instance_uuid_format').with_value(
'[instance: %(uuid)s] ')
is_expected.to contain_watcher_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_watcher_config("DEFAULT/#{param}").with_value('<SERVICE DEFAULT>') }
}
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 'watcher-logging'
end
end
end

36
spec/classes/watcher_policy_spec.rb Normal file
View File

@ -0,0 +1,36 @@
require 'spec_helper'
describe 'watcher::policy' do
shared_examples_for 'watcher-policies' do
let :params do
{
:policy_path => '/etc/watcher/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 'watcher-policies'
end
end
end

5
spec/shared_examples.rb Normal file
View File

@ -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

18
spec/spec_helper.rb Normal file
View File

@ -0,0 +1,18 @@
require 'puppetlabs_spec_helper/module_spec_helper'
require 'shared_examples'
require 'puppet-openstack_spec_helper/defaults'
require 'rspec-puppet-facts'
include RspecPuppetFacts
RSpec.configure do |c|
c.alias_it_should_behave_like_to :it_configures, 'configures'
c.alias_it_should_behave_like_to :it_raises, 'raises'
# TODO(aschultz): remove this after all tests converted to use OSDefaults
# instead of referencing @default_facts
c.before :each do
@default_facts = OSDefaults.get_facts
end
end
at_exit { RSpec::Puppet::Coverage.report! }

1
spec/spec_helper_acceptance.rb Normal file
View File

@ -0,0 +1 @@
require 'puppet-openstack_spec_helper/beaker_spec_helper'

68
spec/unit/provider/watcher_config/ini_setting_spec.rb Normal file
View File

@ -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(:watcher_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::Watcher_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::Watcher_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 <SERVICE DEFAULT> is specified as a value' do
resource = Puppet::Type::Watcher_config.new(
{:name => 'dude/foo', :value => '<SERVICE DEFAULT>'}
)
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::Watcher_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

64
spec/unit/type/watcher_config_spec.rb Normal file
View File

@ -0,0 +1,64 @@
require 'puppet'
require 'puppet/type/watcher_config'
describe 'Puppet::Type.type(:watcher_config)' do
before :each do
@watcher_config = Puppet::Type.type(:watcher_config).new(:name => 'DEFAULT/foo', :value => 'bar')
end
it 'should require a name' do
expect {
Puppet::Type.type(:watcher_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(:watcher_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(:watcher_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(:watcher_config).new(:name => 'DEFAULT/foo', :ensure => :absent)
end
it 'should accept a valid value' do
@watcher_config[:value] = 'bar'
expect(@watcher_config[:value]).to eq('bar')
end
it 'should not accept a value with whitespace' do
@watcher_config[:value] = 'b ar'
expect(@watcher_config[:value]).to eq('b ar')
end
it 'should accept valid ensure values' do
@watcher_config[:ensure] = :present
expect(@watcher_config[:ensure]).to eq(:present)
@watcher_config[:ensure] = :absent
expect(@watcher_config[:ensure]).to eq(:absent)
end
it 'should not accept invalid ensure values' do
expect {
@watcher_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 => 'watcher')
catalog.add_resource package, @watcher_config
dependency = @watcher_config.autorequire
expect(dependency.size).to eq(1)
expect(dependency[0].target).to eq(@watcher_config)
expect(dependency[0].source).to eq(package)
end
end

12
tests/init.pp Normal file
View File

@ -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 ::watcher