Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable template options #61

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

Enable template options #61

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
8475734
Enable parameterized templates
tomas-edwardsson May 20, 2014
ad699c7
Merge branch 'master' into templateopts
tomas-edwardsson May 30, 2014
d6dc236
Fix indent and uncomment main
tomas-edwardsson May 30, 2014
c1d8d19
Fix merge/stash problem
tomas-edwardsson Jun 1, 2014
40a07bf
Merge branch 'master' into templateopts
tomas-edwardsson Jun 1, 2014
1206cae
Pass template_opts merged with opts
tomas-edwardsson Jun 1, 2014
86d2542
Merge template_opts into opts before applying
tomas-edwardsson Jun 6, 2014
9f3a29e
Uncomment defined fields
tomas-edwardsson Jun 10, 2014
6c4d5b8
Merge branch 'master' into templateopts
tomas-edwardsson Jun 10, 2014
51991d7
Use .yml extension instead of yaml
tomas-edwardsson Jun 10, 2014
0cb11cb
Merge branch 'master' into templateopts
tomas-edwardsson Jun 12, 2014
4e1b228
Merge branch 'master' into templateopts
tomas-edwardsson Jun 12, 2014
ae5e40d
Add test for template opts
tomas-edwardsson Jun 12, 2014
b60f8c2
Converted http template to template opt format
tomas-edwardsson Jun 12, 2014
3ee70fb
Remove interactive for now
tomas-edwardsson Jun 12, 2014
1b1f3b3
Re-enable exception handling for parameters
tomas-edwardsson Jun 12, 2014
408a77f
Code review fixes from @palli
tomas-edwardsson Jun 28, 2014
28dd258
Switched from ^ to {} type python str.format
tomas-edwardsson Jun 29, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 122 additions & 43 deletions okconfig/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def verify():

return results

def addhost(host_name, address=None, group_name=None, templates=None, use=None, alias=None, host_template='host', force=False):
def addhost(host_name, address=None, group_name=None, templates=None, use=None, alias=None, host_template='host', force=False, template_opts=None):
"""Adds a new host to Nagios. Returns true if operation is successful.

Args:
Expand Down Expand Up @@ -155,40 +155,49 @@ def addhost(host_name, address=None, group_name=None, templates=None, use=None,
okconfig_groups = get_groups()
if len(okconfig_groups) == 0:
addgroup(group_name='default',alias='OKconfig default group')
arguments = {'PARENTHOST': use, 'GROUP': group_name, 'IPADDR': address, 'HOSTNAME': host_name, 'ALIAS': alias}
destination_dir = "%s/hosts/%s/" % (destination_directory, group_name)
destination_file = "%s/%s-host.cfg" % (destination_dir, host_name)
if not os.path.exists(destination_dir):
os.makedirs(destination_dir)
if not force:
if os.path.isfile(destination_file):
raise OKConfigError("Destination file '%s' already exists." % destination_file)
if group_name not in get_groups():
#raise OKConfigError("Group %s does not exist" % group_name)
addgroup(group_name)
if host_name in get_hosts():
filename = pynag.Model.Host.objects.get_by_shortname(host_name)._meta['filename']
raise OKConfigError("Host named '%s' already exists in %s" % (host_name, filename))
destination_file = destination_dir + "/{HOSTNAME}-host.cfg"

# Do sanity checking of all templates before we add anything
all_templates = get_templates().keys()
if host_template not in all_templates:
raise OKConfigError("Host Template %s not found" % host_template)
for i in templates:
if i not in all_templates:
raise OKConfigError("Template %s not found" % i)
result = _apply_template(host_template, destination_file, **arguments)

if group_name not in get_groups():
addgroup(group_name)

if not force:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can also be like following to decrease indent hell:

if not force and host_name in get_hosts():

if host_name in get_hosts():
filename = pynag.Model.Host.objects.get_by_shortname(
host_name)._meta['filename']
raise OKConfigError("Host named '%s' already exists in %s" % (
host_name, filename))

result = _apply_template(host_template, destination_file,
force=force,
opts={
'PARENTHOST': use,
'GROUP': group_name,
'IPADDR': address,
'HOSTNAME': host_name,
'ALIAS': alias
}, template_opts=template_opts)
_git_commit(filelist=result, message='okconfig host %s added with address %s' % (host_name,address))
for i in templates:
result = result + addtemplate(host_name=host_name, template_name=i, group_name=group_name,force=force)
return result
def addtemplate(host_name, template_name, group_name=None,force=False):

def addtemplate(host_name, template_name, group_name=None, force=False, template_opts=None):
"""Adds a new template to existing host in Nagios.

Args:
host_name -- Hostname to add template to (i.e. "host.example.com")
template_name -- Name of the template to be added (i.e. "mysql")
force -- Force operation, overwrites configuration if it already exists

f
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this

Examples:
addtemplate(host_name="host.example.com", template="mysql")

Expand All @@ -214,17 +223,21 @@ def addtemplate(host_name, template_name, group_name=None,force=False):
helper_functions.add_defaultservice_to_host(host_name)

# Lets do some templating
newfile = "%s/%s-%s.cfg" % (hostdir, host_name,template_name)
if not force:
# 'Do some basic sanity checking'
if os.path.exists(newfile):
raise OKConfigError("Destination file '%s' already exists." % newfile)
filename = hostdir + "/{HOSTNAME}-{TEMPLATE}.cfg"

opts = { 'HOSTNAME': host_name,
'TEMPLATE': template_name,
'GROUP': group_name, }

result = _apply_template(template_name, destination_file=filename,
force=force,
opts=opts,
template_opts=template_opts)

result = _apply_template(template_name,newfile, HOSTNAME=host_name, GROUP=group_name)
_git_commit(filelist=result, message='okconfig template %s added to host %s' % (template_name, host_name))
return result

def addgroup(group_name, alias=None, force=False):
def addgroup(group_name, alias=None, force=False, template_opts=None):
"""Adds a new hostgroup/contactgroup/servicegroup combo to Nagios.

Args:
Expand All @@ -240,18 +253,22 @@ def addgroup(group_name, alias=None, force=False):
"""
if alias is None: alias=group_name
destination_dir = "%s/groups" % destination_directory
destination_file = "%s/%s.cfg" % (destination_dir, group_name)
destination_file = destination_dir + "/{GROUP}.cfg"
if not force:
# 'Do some sanity checking'
if os.path.exists(destination_file):
raise OKConfigError("Destination file '%s' already exists" % destination_file)
groups = helper_functions.group_exists(group_name)
if groups != False:
raise OKConfigError("We already have groups with name = %s" % group_name)

result = _apply_template(template_name="group",destination_file=destination_file, GROUP=group_name, ALIAS=alias)
result = _apply_template(template_name="group",
destination_file=destination_file,
force=force,
opts={
'GROUP': group_name,
'ALIAS': alias
}, template_opts=template_opts)
_git_commit(filelist=result, message="okconfig group %s added" % group_name)
return result

def addcontact(contact_name, alias=None, force=False, group_name="default", email=None, use='generic-contact'):
"""Adds a new contact to Nagios.

Expand Down Expand Up @@ -382,20 +399,28 @@ def get_templates():
""" Returns a list of available templates """
result = {}
if not os.path.isdir(examples_directory):
raise OKConfigError("Examples directory does not exist: %s" % examples_directory)
raise OKConfigError("Examples directory does not exist: %s" %
examples_directory)
filelist = os.listdir(examples_directory)
if os.path.isdir(examples_directory_local):
for i in os.listdir(examples_directory_local):
if i not in filelist:
filelist.append(i)
for file in filelist:
if os.path.isfile(examples_directory + "/" + file): filename = examples_directory + "/" + file
if os.path.isfile(examples_directory_local + "/" + file): filename = examples_directory_local + "/" + file
if os.path.isfile(examples_directory + "/" + file):
filename = examples_directory + "/" + file
if os.path.isfile(examples_directory_local + "/" + file):
filename = examples_directory_local + "/" + file
if file.endswith('.cfg-example'):
template_name = file[:-12]
template_parents = []
template_friendly_name = ''
result[template_name] = {'parents':template_parents, 'filename':filename, 'name':template_friendly_name}
result[template_name] = {'parents':template_parents,
'filename':filename,
'name':template_friendly_name}
if os.path.isfile(filename[:-12] + ".yml"):
result[template_name]['template_opt_file'] = \
filename[:-12] + ".yml"
return result

def get_hosts():
Expand Down Expand Up @@ -516,39 +541,93 @@ def install_nrpe(remote_host, username, password=None):

return exit_status,stdout,stderr

def _apply_template(template_name,destination_file, **kwargs):
""" Applies okconfig template to filename, doing replacements from kwargs in the meantime
def _apply_template(template_name, destination_file, force, opts, template_opts):
""" Applies okconfig template to filename, doing replacements from opts in the meantime

Arguments:
template_name - name of the template to use
filename - template for filename, eg "{HOSTNAME}-{TEMPLATE}.cfg"
destination_file - full path to file to be written to
kwargs key/value pair of string to search and replacement to make
opts key/value pair of string to search and replacement to make

Example:
_apply_template('host','/etc/nagios/okconfig/hosts/newhost.cfg', HOSTNAME='newhost',ADDRESS='0.0.0.0',GROUP='default')
Returns:
List of filenames that have been written to
"""
all_examples = get_templates()

if not all_examples.has_key(template_name):
raise OKConfigError('Template %s cannot be found' % template_name)
sourcefile = all_examples[template_name]['filename']
template = all_examples[template_name]

# Clean // from destination file
destination_file = destination_file.replace('//','/')

if not os.path.isfile(sourcefile):
if not os.path.isfile(template['filename']):
raise OKConfigError('Template %s cannot be found' % template_name)

dirname = os.path.dirname(destination_file)
if not os.path.exists(dirname): os.makedirs(dirname)
if not os.path.exists(dirname):
os.makedirs(dirname)

template_output = open(template['filename'], "r").read()
for old_string,new_string in opts.items():
template_output = template_output.replace(old_string,new_string)

if template_opts:
opts.update(template_opts)

destination_file = destination_file.format(**opts)

fd = open(sourcefile).read()
for old_string,new_string in kwargs.items():
fd = fd.replace(old_string,new_string)
open(destination_file,'w').write( fd )
if 'template_opt_file' in template:
template_output, filename = _apply_template_opts(template,
template_output,
opts)
destination_file = "/".join(destination_file.split("/")[:-1]) + "/" +\
filename

if not force:
if os.path.isfile(destination_file):
raise OKConfigError("Destination file '%s' already exists." %
destination_file)


open(destination_file,'w').write( template_output )
return [destination_file]

def _apply_template_opts(template, template_output, opts):
template_opts = _parse_template_opts(template['template_opt_file'])

for k in template_opts['parms']:
opt = template_opts['parms'][k]
v = ""
if k in opts:
v = opts[k]
template_output = template_output.replace("#__" + k, "__" + k)
else:
if opt['default']:
v = str(opt['default'])
if v[:2] == "k:":
v = opts[v[2:]]
if not v and 'mandatory' in opt and opt['mandatory'] == True:
raise OKConfigError('Missing template parameter ' + k)
opts[k] = v
template_output = template_output.replace("^" + k, v)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not convinced that ^ is a good way to indicate template options. Maybe better, and less error prone to use {VARIABLE}
and then use built-in python's string.format():

template_output = template_output.format(**template_opts)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent idea, I'll get this worked in.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@palli Switched to str.format from ^ in 28dd258


if 'filename' not in template_opts:
raise OKConfigError("Missing filename in template option file")

filename = template_opts['filename'].format(**opts)
return template_output, filename

def _parse_template_opts(opt_file):
import yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this import to the top of the file.

Also, please put yaml dependency in requirements.txt, rpm spec file and debian/ directory


fh = open(opt_file, "r")
template_opts = yaml.load(fh)
return template_opts

def _git_commit(filelist, message):
""" If config.git_commit_changes is enabled, then commit "filelist" to the repository using message """
if config.git_commit_changes != '1':
Expand Down
29 changes: 25 additions & 4 deletions tests/test_template.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ def test_basic(self):

services = Model.Service.objects.filter(
host_name="www.okconfig.org",
use="okc-check_http",
service_description="HTTP www.okconfig.org")
service_description="HTTP www.okconfig.org"
)

self.assertEquals(len(services), 1, "There can be only one")

Expand Down Expand Up @@ -75,15 +75,36 @@ def test_force(self):
def test_group(self):
"""Test adding template with group"""
okconfig.addtemplate("aliased.okconfig.org",
"http",
"linux",
group_name="webgroup")

services = Model.Service.objects.filter(
host_name="aliased.okconfig.org",
service_description="HTTP aliased.okconfig.org",
service_description="Disk Usage",
)
self.assertEqual(1, len(services), "There can be only one")
self.assertEqual(services[0].contact_groups, "webgroup")

def test_template_opts_basic(self):
"""Test adding template with opts"""
okconfig.addtemplate(
host_name='linux.okconfig.org',
template_name='http',
template_opts={'SEARCH_STRING': 'test',
'VIRTUAL_HOST': 'bing.okconfig.org'}
)

services = Model.Service.objects.filter(
host_name="linux.okconfig.org",
service_description="HTTP bing.okconfig.org"
)
self.assertEqual(1, len(services), "There can be only one")

service = services[0]
self.assertEqual(service['__SEARCH_STRING'], 'test')
self.assertEqual(service['__VIRTUAL_HOST'], 'bing.okconfig.org')



if __name__ == "__main__":
unittest.main()
12 changes: 9 additions & 3 deletions usr/bin/okconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ def listhosts():

def listtemplates():
""" List all available oktemplates """
for i in okconfig.get_templates():
for i in sorted(okconfig.get_templates()):
print i


Expand Down Expand Up @@ -321,6 +321,8 @@ Run %prog addtemplate --help for full list of command line arguments.
help="Name of template to use")
parser.add_option("--force", dest="force", action="store_true",
default=False, help="Overwrite files if needed")
parser.add_option("--opt", dest="options", action="append",
default=[], help="Options for template, eg PROC=crond")
(opts, args) = parser.parse_args(sys.argv[2:])

if not opts.host:
Expand All @@ -332,10 +334,14 @@ Run %prog addtemplate --help for full list of command line arguments.
if not opts.template or not opts.host:
parser.error("Please specify both host and template. See --help")
templates = opts.template.split(',')
template_opts = {}
for template_opt in opts.options:
k, v = template_opt.split("=", 1)
template_opts[k] = v
for template_name in templates:
f = okconfig.addtemplate(
host_name=opts.host, template_name=template_name,
force=opts.force)
force=opts.force, template_opts=template_opts)
for i in f:
print "Saved", i

Expand Down Expand Up @@ -454,4 +460,4 @@ if __name__ == '__main__':
try:
parse_arguments()
except Exception, e:
print "Error: ", e
print "Error: ", e
17 changes: 9 additions & 8 deletions usr/share/okconfig/examples/http.cfg-example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@

define service {
use okc-check_http
host_name HOSTNAME
contact_groups GROUP
service_description HTTP HOSTNAME
service_description HTTP ^VIRTUAL_HOST
#check_command okc-check_http

__URI /
__SEARCH_STRING
__RESPONSE_WARNING 2
__RESPONSE_CRITICAL 10
__VIRTUAL_HOST HOSTNAME
__PORT 80
__VIRTUAL_HOST ^VIRTUAL_HOST
#__URI ^URI
#__SEARCH_STRING ^SEARCH_STRING
#__RESPONSE_WARNING ^RESPONSE_WARNING
#__RESPONSE_CRITICAL ^RESPONSE_CRITICAL
#__PORT ^PORT
#__ON_REDIRECT follow

}



Loading