pagure-new/pagure/hooks/pagure_unsigned_commits.py

93 lines
2.4 KiB
Python

# -*- coding: utf-8 -*-
"""
(c) 2016 - Copyright Red Hat Inc
Authors:
Pierre-Yves Chibon <pingou@pingoured.fr>
"""
import flask_wtf as wtf
import sqlalchemy as sa
import wtforms
from sqlalchemy.orm import relation
from sqlalchemy.orm import backref
from pagure.hooks import BaseHook
from pagure.lib.model import BASE, Project
from pagure import get_repo_path
class PagureUnsignedCommitTable(BASE):
""" Stores information about the pagure hook deployed on a project.
Table -- hook_pagure_unsigned_commit
"""
__tablename__ = 'hook_pagure_unsigned_commit'
id = sa.Column(sa.Integer, primary_key=True)
project_id = sa.Column(
sa.Integer,
sa.ForeignKey(
'projects.id', onupdate='CASCADE', ondelete='CASCADE'),
nullable=False,
unique=True,
index=True)
active = sa.Column(sa.Boolean, nullable=False, default=False)
project = relation(
'Project', foreign_keys=[project_id], remote_side=[Project.id],
backref=backref(
'pagure_unsigned_commit_hook', cascade="delete, delete-orphan",
single_parent=True, uselist=False)
)
class PagureUnsignedCommitForm(wtf.Form):
''' Form to configure the pagure hook. '''
active = wtforms.BooleanField(
'Active',
[wtforms.validators.Optional()]
)
class PagureUnsignedCommitHook(BaseHook):
''' PagurPagureUnsignedCommit hook. '''
name = 'Block Un-Signed commits'
description = 'Using this hook you can block any push with commits '\
'missing a "Signed-Off-By"'
form = PagureUnsignedCommitForm
db_object = PagureUnsignedCommitTable
backref = 'pagure_unsigned_commit_hook'
form_fields = ['active']
hook_type = 'pre-receive'
@classmethod
def install(cls, project, dbobj):
''' Method called to install the hook for a project.
:arg project: a ``pagure.model.Project`` object to which the hook
should be installed
'''
repopaths = [get_repo_path(project)]
cls.base_install(repopaths, dbobj, 'pagureunsignedcommit',
'pagure_block_unsigned.py')
@classmethod
def remove(cls, project):
''' Method called to remove the hook of a project.
:arg project: a ``pagure.model.Project`` object to which the hook
should be installed
'''
repopaths = [get_repo_path(project)]
cls.base_remove(repopaths, 'pagureunsignedcommit')