"""
configgen.py: Generate configuration data.
Copyright 2010 Kelsey Hightower
Kelsey Hightower <kelsey.hightower@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
module for generating configuration manifest using autoinstall_meta data, mgmtclasses, resources, and templates for a
given system (hostname)
"""
import json
import string
from typing import Dict, Union
from cobbler.cexceptions import CX
from cobbler import template_api
import cobbler.utils
from cobbler import utils
# FIXME: This is currently getting the blendered data. Make use of the object and only process the required data.
# FIXME: Obsolete this class. All methods are wrappers or tailcalls except gen_config_data and this can be integrated
# somewhere else (educated guess: System or Koan directly).
[docs]class ConfigGen:
"""
Generate configuration data for Cobbler's management resources: repos, files and packages.
Mainly used by Koan to configure systems.
"""
def __init__(self, cobbler_api, hostname: str):
"""
Constructor. Requires a Cobbler API handle.
:param hostname: The hostname to run config-generation for.
"""
# FIXME: This should work via the system name or system record and if that doesn't exist it should not fail.
self.hostname = hostname
self.__api = cobbler_api
self.system = self.__api.find_system(hostname=self.hostname)
if self.system is None:
raise ValueError("The specified hostname did not exist!")
# This below var needs a dict but the method may possibly return an empty str.
self.host_vars = self.get_cobbler_resource('autoinstall_meta')
self.mgmtclasses = self.get_cobbler_resource('mgmt_classes')
# ----------------------------------------------------------------------
[docs] def resolve_resource_var(self, string_data: str) -> str:
"""
Substitute variables in strings with data from the ``autoinstall_meta`` dictionary of the system.
:param string_data: The template which will then be substituted by the variables in this class.
:return: A str with the substituted data. If the host_vars are not of type dict then this will return an empty
str.
:raises KeyError: When the autoinstall_meta variable does not contain the required Keys in the dict.
"""
if not isinstance(self.host_vars, dict):
return ""
return string.Template(string_data).substitute(self.host_vars)
# ----------------------------------------------------------------------
[docs] def get_cobbler_resource(self, resource_key: str) -> Union[list, str, dict]:
"""
Wrapper around Cobbler blender method
:param resource_key: Not known what this actually is doing.
:return: The blendered data. In some cases this is a str, in others it is a list or it might be a dict. In case
the key is not found it will return an empty string.
"""
system_resource = cobbler.utils.blender(self.__api, False, self.system)
if resource_key not in system_resource:
return ""
return system_resource[resource_key]
# ----------------------------------------------------------------------
[docs] def gen_config_data(self) -> dict:
"""
Generate configuration data for repos, files and packages.
:return: A dict which has all config data in it.
:raises CX: In case the package or file resource is not defined.
"""
config_data = {
'repo_data': self.__api.get_repo_config_for_system(self.system),
'repos_enabled': self.get_cobbler_resource('repos_enabled'),
}
package_set = set()
file_set = set()
for mgmtclass in self.mgmtclasses:
_mgmtclass = self.__api.find_mgmtclass(name=mgmtclass)
for package in _mgmtclass.packages:
package_set.add(package)
for file in _mgmtclass.files:
file_set.add(file)
# Generate Package data
pkg_data: Dict[str, Dict[str, str]] = {}
for package in package_set:
_package = self.__api.find_package(name=package)
if _package is None:
raise CX('%s package resource is not defined' % package)
else:
pkg_data[package] = {}
pkg_data[package]['action'] = self.resolve_resource_var(_package.action)
pkg_data[package]['installer'] = _package.installer
pkg_data[package]['version'] = self.resolve_resource_var(_package.version)
if pkg_data[package]['version'] != "":
pkg_data[package]["install_name"] = "%s-%s" % (package, pkg_data[package]['version'])
else:
pkg_data[package]["install_name"] = package
config_data['packages'] = pkg_data
# Generate File data
file_data: Dict[str, Dict[str, str]] = {}
for file in file_set:
_file = self.__api.find_file(name=file)
if _file is None:
raise CX('%s file resource is not defined' % file)
file_data[file] = {}
file_data[file]['is_dir'] = _file.is_dir
file_data[file]['action'] = self.resolve_resource_var(_file.action)
file_data[file]['group'] = self.resolve_resource_var(_file.group)
file_data[file]['mode'] = self.resolve_resource_var(_file.mode)
file_data[file]['owner'] = self.resolve_resource_var(_file.owner)
file_data[file]['path'] = self.resolve_resource_var(_file.path)
if not _file.is_dir:
file_data[file]['template'] = self.resolve_resource_var(_file.template)
try:
t = template_api.CobblerTemplate(file=file_data[file]['template'], searchList=[self.host_vars])
file_data[file]['content'] = t.respond()
except:
utils.die("Missing template for this file resource %s" % (file_data[file]))
config_data['files'] = file_data
return config_data
# ----------------------------------------------------------------------
[docs] def gen_config_data_for_koan(self) -> str:
"""
Encode configuration data. Return json object for Koan.
:return: A json string for koan.
"""
# TODO: This can be merged with the above method if we want to obsolete this class. If not, we need to create
# helper objects instead of just having a nested dictionary.
json_config_data = json.JSONEncoder(sort_keys=True, indent=4).encode(self.gen_config_data())
return json_config_data