def load_transaction(self, name):
"""
Load the transaction with the given name.
:param name: The name of the current transaction.
:type name: string
"""
self.transaction = Transaction(self.repository_path, name)
def load_transaction(self, name):
"""
Load the transaction with the given name.
:param name: The name of the current transaction.
:type name: string
"""
self.transaction = Transaction(self.repository_path, name)
class RepoGuard(object):
"""
Main RepoGuard class.
"""
def __init__(self, hook, repository_path):
"""
Constructor.
:param hook: The hook that has to be executed. Valid values are
constants.PRECOMMIT or constants.POSTCOMMIT.
:type hook: constants.PRECOMMIT, constants.POSTCOMMIT.
:param repository_path: The path to the current repository.
:type repository_path: string
"""
self.hook = hook
self.repository_path = repository_path
self.checks = CheckManager()
self.handlers = HandlerManager()
self.result = constants.SUCCESS
self.main = None
self.transaction = None
self.logger = LoggerFactory().create(self.__module__)
def load_transaction(self, name):
"""
Load the transaction with the given name.
:param name: The name of the current transaction.
:type name: string
"""
self.transaction = Transaction(self.repository_path, name)
def load_config(self, tpl_dirs, config):
"""
Load the project configuration.
:param tpl_dirs: Path lists where all templates are located.
:type tpl_dirs: string
:param config: The path or a splittedline project configuration string.
:type config: string
"""
self.logger.debug("Loading project configuration...")
hooks_path = os.path.join(self.repository_path, "hooks")
self.main = ProjectConfig(config, hooks_path, tpl_dirs)
self.logger.debug("Project configuration loaded.")
def validate(self):
"""
Runs the internal validation process of the current loaded
configuration.
:return: Returns the status code of the validator. succes = 0, error > 0
:rtype: integer
"""
validator = ConfigValidator(excepts=True)
return validator.validate(self.main)
def _combined_profile_regexes(self):
"""
Returns a regular expression string which matches all
files that are covered by any special profile. A special
profile defines a non-empty regex parameter.
"""
combined_profile_regexes = ""
for profile in self.main.profiles:
if not profile.regex is None:
combined_profile_regexes += "(%s)|" % profile.regex
if not combined_profile_regexes:
combined_profile_regexes = None
else:
combined_profile_regexes = combined_profile_regexes[:-1]
return combined_profile_regexes
def run(self):
"""
Execution of the checking _process and handler handling.
It is recommended to call the load_config method before
calling this method.
:return: Returns the _process result as a constant string.
:rtype: constants.SUCCESS, constants.ERROR
"""
try:
self.logger.debug("Running run...")
combined_profile_regexes = self._combined_profile_regexes()
self.logger.debug("Default ignore regex: %s", combined_profile_regexes)
# Process executing
for profile in self.main.profiles:
ignores = list()
if not profile.regex is None:
self.transaction.profile = profile.regex
else:
# default profile: covers all files
# which are not handled by a special profile
self.transaction.profile = ".*"
if not combined_profile_regexes is None:
ignores = [combined_profile_regexes]
# if there are no files in this profile continue.
if not self.transaction.get_files(ignore_list=ignores):
self.logger.debug("Profile '%s' skipped.", profile.name)
continue
self._run_profile(profile)
self.logger.debug("Run finished with %s.", self.result)
return self.result
finally:
self.logger.debug("Cleaning up transaction.")
self.transaction.cleanup()
def run_profile(self, name):
""" Runs a specific profile. """
try:
profile_found = False
for profile in self.main.profiles:
if name == profile.name:
self._run_profile(profile)
profile_found = True
if not profile_found:
self.result = constants.ERROR
self.logger.error("No profile with name '%s' exists." % name)
else:
self.logger.debug("Run finished with %s.", self.result)
return self.result
finally:
self.logger.debug("Cleaning up transaction.")
self.transaction.cleanup()
def _run_profile(self, profile):
process = profile.get_process(self.hook)
if not process:
self.logger.debug(
"%s process skipped." % self.hook.capitalize()
)
return
self.logger.debug("Running profile '%s'...", profile.name)
protocol = Protocol(profile.name)
# run the configured checks
for name, config, interp in process.checks:
self.logger.debug("Loading check %s...", name)
check = self.checks.fetch(name, self.transaction)
self.logger.debug("Starting check %s...", name)
entry = check.run(config, interp)
self.logger.debug(
"Check %s finished with %s.", name, entry.result
)
protocol.append(entry)
# run the configured handlers when a message was returned
if entry.msg:
self.logger.debug(
"Running handler after check %s...", entry.check
)
self.handlers.singularize(self.transaction, process, entry)
self.logger.debug(
"Handler after check %s finished.", entry.check
)
# cancel the _process chain when an abortonerror was detected.
if interp == constants.ABORTONERROR and not protocol.success:
msg = "Profile %s aborted after check %s."
self.logger.debug(msg, profile.name, entry.check)
break
# cumulativ execution of all handlers.
self.logger.debug("Running handler summarize...")
self.handlers.summarize(self.transaction, process, protocol)
self.logger.debug("Handler summarize finished.")
if not protocol.success:
self.result = constants.ERROR
self.logger.debug("Profile %s finished.", profile.name)
class RepoGuard(object):
"""
Main RepoGuard class.
"""
def __init__(self, hook, repository_path):
"""
Constructor.
:param hook: The hook that has to be executed. Valid values are
constants.PRECOMMIT or constants.POSTCOMMIT.
:type hook: constants.PRECOMMIT, constants.POSTCOMMIT.
:param repository_path: The path to the current repository.
:type repository_path: string
"""
self.hook = hook
self.repository_path = repository_path
self.checks = CheckManager()
self.handlers = HandlerManager()
self.result = constants.SUCCESS
self.main = None
self.transaction = None
self.logger = LoggerFactory().create(self.__module__)
def load_transaction(self, name):
"""
Load the transaction with the given name.
:param name: The name of the current transaction.
:type name: string
"""
self.transaction = Transaction(self.repository_path, name)
def load_config(self, tpl_dirs, config):
"""
Load the project configuration.
:param tpl_dirs: Path lists where all templates are located.
:type tpl_dirs: string
:param config: The path or a splittedline project configuration string.
:type config: string
"""
self.logger.debug("Loading project configuration...")
hooks_path = os.path.join(self.repository_path, "hooks")
self.main = ProjectConfig(config, hooks_path, tpl_dirs)
self.logger.debug("Project configuration loaded.")
def validate(self):
"""
Runs the internal validation process of the current loaded
configuration.
:return: Returns the status code of the validator. succes = 0, error > 0
:rtype: integer
"""
validator = ConfigValidator(excepts=True)
return validator.validate(self.main)
def _combined_profile_regexes(self):
"""
Returns a regular expression string which matches all
files that are covered by any special profile. A special
profile defines a non-empty regex parameter.
"""
combined_profile_regexes = ""
for profile in self.main.profiles:
if not profile.regex is None:
combined_profile_regexes += "(%s)|" % profile.regex
if not combined_profile_regexes:
combined_profile_regexes = None
else:
combined_profile_regexes = combined_profile_regexes[:-1]
return combined_profile_regexes
def run(self):
"""
Execution of the checking _process and handler handling.
It is recommended to call the load_config method before
calling this method.
:return: Returns the _process result as a constant string.
:rtype: constants.SUCCESS, constants.ERROR
"""
try:
self.logger.debug("Running run...")
combined_profile_regexes = self._combined_profile_regexes()
self.logger.debug("Default ignore regex: %s",
combined_profile_regexes)
# Process executing
for profile in self.main.profiles:
ignores = list()
if not profile.regex is None:
self.transaction.profile = profile.regex
else:
# default profile: covers all files
# which are not handled by a special profile
self.transaction.profile = ".*"
if not combined_profile_regexes is None:
ignores = [combined_profile_regexes]
# if there are no files in this profile continue.
if not self.transaction.get_files(ignore_list=ignores):
self.logger.debug("Profile '%s' skipped.", profile.name)
continue
self._run_profile(profile)
self.logger.debug("Run finished with %s.", self.result)
return self.result
finally:
self.logger.debug("Cleaning up transaction.")
self.transaction.cleanup()
def run_profile(self, name):
""" Runs a specific profile. """
try:
profile_found = False
for profile in self.main.profiles:
if name == profile.name:
self._run_profile(profile)
profile_found = True
if not profile_found:
self.result = constants.ERROR
self.logger.error("No profile with name '%s' exists." % name)
else:
self.logger.debug("Run finished with %s.", self.result)
return self.result
finally:
self.logger.debug("Cleaning up transaction.")
self.transaction.cleanup()
def _run_profile(self, profile):
process = profile.get_process(self.hook)
if not process:
self.logger.debug("%s process skipped." % self.hook.capitalize())
return
self.logger.debug("Running profile '%s'...", profile.name)
protocol = Protocol(profile.name)
# run the configured checks
for name, config, interp in process.checks:
self.logger.debug("Loading check %s...", name)
check = self.checks.fetch(name, self.transaction)
self.logger.debug("Starting check %s...", name)
entry = check.run(config, interp)
self.logger.debug("Check %s finished with %s.", name, entry.result)
protocol.append(entry)
# run the configured handlers when a message was returned
if entry.msg:
self.logger.debug("Running handler after check %s...",
entry.check)
self.handlers.singularize(self.transaction, process, entry)
self.logger.debug("Handler after check %s finished.",
entry.check)
# cancel the _process chain when an abortonerror was detected.
if interp == constants.ABORTONERROR and not protocol.success:
msg = "Profile %s aborted after check %s."
self.logger.debug(msg, profile.name, entry.check)
break
# cumulativ execution of all handlers.
self.logger.debug("Running handler summarize...")
self.handlers.summarize(self.transaction, process, protocol)
self.logger.debug("Handler summarize finished.")
if not protocol.success:
self.result = constants.ERROR
self.logger.debug("Profile %s finished.", profile.name)