gitWebhook

Gitwebhook

Библиотека Python, предоставляющая чертежи Flask для получения GitHub, Gitlab или Gitea Webhooks и действует на них. Библиотека предоставляет веб -крючки, позволяющие автоматическое развертывание, тестирование и интеграции. Однако из -за открытой природы чертежа это поведение может быть легко настроено благодаря очень открытому дереву зависимости класса.

Настраивать

1. Настройка WebHook на стороне GIT во время установки Обязательно обратите пристальное внимание на любые возможности для ввода любого секретного ключа. Вам понадобится этот ключ позже, если вы хотите включить проверку WebHook , это то, что я очень советую вам . Для GitHub это будет секретной строкой, которую вы предоставляете во время создания, для Gitlab, это будет секретный токен и для Gitea, это будет токен авторизации.

2. Установите этот пакет

   • Использование PIP

     pip install gitAppWebhook

   • Клонируя репозиторий

     git clone https://github.com/TCA166/gitWebhook.git
     pip install -r gitWebhook/requirements.txt

   • Включив этот репо в подмодуле

     git submodule add https://github.com/example/repo.git gitWebhook
     pip install -r gitWebhook/requirements.txt

   При установке функций пакета PIP как любой другой пакет, с этой папкой репо является то, что он функционирует как локальный пакет. Это означает, что клонирование этого репо в папку проекта позволит вам импортировать gitWebhook как если бы он был установлен через PIP. То же самое относится и к добавлению в качестве подмодуля с дополнительным преимуществом GIT, понимая, что происходит лучше,

3. Создайте экземпляр webhookBlueprint (или любой из его подклассов) с вашими настройками

    import gitWebhook
   
   wb = gitWebhook . webhookBlueprint ( token , url_prefix = "/" )

4. Зарегистрируйте экземпляр в приложении Flask по вашему выбору

    from flask import Flask
   
   app = Flask ( __name__ )
   app . register_blueprint ( wb )

Если вы потеряны, вы всегда можете посмотреть на официальные ресурсы GitHub или посмотреть на wsgi.py, где находится пример, настроенный Flask WebApp.

Классы чертежа

Эта библиотека предоставляет базовый класс, полученный в плане, только для получения только веб -крючков и нескольких полученных классов с различными возможностями обработки веб -крюков.

webhookblueprint

Этот самый базовый класс сам не обладает возможностями обработки веб -крючков, но функционирует как база, из которой могут быть получены чертежи, получающие веб -хук. Он полностью реализует всю проверку, необходимую для чертех Github и Gitlab, и, как таковой, должен быть класс, из которого вы должны получить.

Webhookblueprint поведение

1. Проверяет обоснованность запроса (необязательно, но очень рекомендуется)
2. Возврат 200

Pullerwebhookblueprint

Этот класс, полученный из webhookBlueprint , направлен на использование в качестве средства автоматизации развертывания и тестирования на серверах. Если вы не хотите использовать действия GitHub, вы всегда можете использовать приложение Flask с зарегистрированным планом.

PullerWebHookBluePrint поведение

Получив запрос на POST в / конечную точку плана:

1. Проверяет обоснованность запроса (необязательно, но очень рекомендуется)
2. Выполняет git pull
3. Запускает тестовый набор (необязательно)
   1. Если тесты не удались, он пытается вернуть тягу
4. Возвращается в GitHub или Gitlab результаты притяжения и тестов, если они были выполнены

functionWebHookBluePrint

Этот класс, полученный из webhookBlueprint , направлен на использование в качестве средства интеграции различных услуг. Вы предоставляете его при инициализации со списком Callable приемов в Webhook Power Aloads в качестве единого аргумента, и эти функции будут вызваны при получении веб -крючка. Таким образом, вы можете легко интегрировать сервисы с этим классом, просто имея интеграцию в таком Callable .

functionWebHookBlueEprint поведение

Получив запрос POST в / конечную точку плана:

1. Проверяет обоснованность запроса (необязательно, но очень рекомендуется)
2. Вызовы все функции, содержащиеся в списке functions
3. Если вообще возвращается ложь, он возвращает неспособность до происхождения.

Настройка

Вы можете легко настроить любой из классов по своему вкусу двумя способами.

1. Некоторые настройки могут быть настроены во время создания экземпляра Blueprint. Ты можешь:
   • включить или отключить проверку веб -крюков, предоставляя (или не предоставляя) webhookToken
   • Включить модульный тест, выполняемый, предоставляя экземпляр unittest.testSuite (Pullerwebhookblueprint)
   • Включить регистрацию, предоставив экземпляр logging.Logger
   • Изменить имя Blueprint, чтобы избежать конфликтов во время регистрации плана
   • Ограничьте чертежи, чтобы принять веб -хуки только из одного приложения GIT или нескольких
   • Ограничьте чертежи, чтобы принять входящие веб -крючки только от IPS с белым списком
   • Измените команду, используемую для вызова git (pullerwebhookblueprint)
   • Изменить среду ОС, используемая в процессах Git GIT (Pullerwebhookblueprint)
2. Более продвинутые изменения требуют создания подкласса от Webhookblueprint Это не так уж и пугающе. В классе есть два метода: receiveWebhook и processWebhook . Переопределите первое, чтобы изменить то, как обрабатывается и проверяется запрос RAW. Переопределите последнее, чтобы изменить то, что сделано, как только веб -крюк будет проверен.

Лицензия

Эта работа лицензирована по лицензии MIT.