gitWebhook

Gitwebhook

Uma biblioteca Python que fornece plantas de frasco para receber webhooks Github, Gitlab ou Gitea e agir sobre eles. A biblioteca fornece webhooks, permitindo implantação automática, teste e integrações. No entanto, devido à natureza aberta do plano, esse comportamento pode ser facilmente personalizado, graças à árvore de dependência de classe muito aberta.

Configurar

1. Configure o webhook do lado Git durante a configuração Certifique -se de prestar muita atenção a qualquer oportunidade de inserir qualquer tipo de chave secreta. Você precisará dessa chave mais tarde, se desejar ativar a verificação do webhook , isso é algo que eu aconselho muito . Para o Github, essa seria a sequência secreta que você fornece durante a criação, para o Gitlab que seria o token secreto e para Gitea que seria o token de autorização.

2. Instale este pacote

   • Usando pip

     pip install gitAppWebhook

   • Clonando o repositório

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

   • Incluindo este repo como submódulo

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

   Ao instalar o pacote PIP, funciona como qualquer outro pacote com esta pasta repo é que ele funciona como um pacote local. Isso significa que clonar esse repositório na pasta do projeto permitirá que você importe gitWebhook como se estivesse instalado via PIP. O mesmo se aplica à adição de submodule com o benefício adicional do Git, entendendo o que está acontecendo melhor,

3. Crie uma instância do webhookBlueprint (ou de suas subclasses) com suas configurações

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

4. Registre a instância em um aplicativo de frasco de sua escolha

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

Se você está perdido, sempre pode olhar para os recursos oficiais do GitHub ou olhar para o wsgi.py onde está localizado um exemplo de FlaskpApp de Flash.

Aulas de plano

Esta biblioteca fornece uma classe básica derivada de plano para receber apenas webhooks e algumas classes derivadas com diferentes recursos de processamento da webhook.

WebHookBluePrint

Essa classe muito básica em si não possui recursos de processamento da webhook, mas funciona como uma base a partir da qual a WebHook que recebe projetos pode ser derivada. Ele implementa totalmente toda a verificação necessária para os planos do GitHub e do Gitlab e, como tal, deve ser a classe que você deve derivar.

WebHookBluePrint Behavior

1. Verifica a validade da solicitação (opcional, mas muito recomendada)
2. Retorna 200

Pullerwebhookblueprint

Esta classe derivada do webhookBlueprint pretende ser usada como um meio de automatizar a implantação e o teste em servidores. Se você não deseja usar ações do GitHub, sempre pode usar um aplicativo de frasco com este plano registrado.

Comportamento Pullerwebhookblueprint

Ao receber uma solicitação POST para o / endpoint the Blueprint:

1. Verifica a validade da solicitação (opcional, mas muito recomendada)
2. Executa uma git pull
3. Executa uma suíte de teste (opcional)
   1. Se os testes falharem, tentará reverter a atração
4. Retorna ao github ou gitlab os resultados da tração e testa se eles tiverem sido realizados

functionwebhookblueprint

Esta classe derivada do webhookBlueprint pretende ser usada como um meio de integrar diferentes serviços. Você o fornece na inicialização com uma lista de Callable de compra de webhook como um único argumento, e essas funções serão chamadas ao receber um webhook. Assim, você pode facilmente integrar serviços a esta classe, simplesmente fazendo com que a integração aconteça em tal Callable .

FunctionWebHookBluePrint Behavior

Ao receber uma solicitação POST para o / endpoint the Blueprint:

1. Verifica a validade da solicitação (opcional, mas muito recomendada)
2. Chamadas todas as funções contidas na lista functions
3. Se algum retorno false, ele retornará uma falha na origem.

Personalização

Você pode facilmente ajustar qualquer uma das classes do seu gosto de duas maneiras.

1. Algumas configurações podem ser ajustadas durante a criação da instância do Blueprint. Você pode:
   • Ativar ou desativar a verificação do webhook, fornecendo (ou não fornecendo) um webhookToken
   • Habilite o teste de unidade em execução fornecendo uma instância unittest.testSuite (PullerwebhookbluePrint)
   • Habilite o registro fornecendo uma instância logging.Logger
   • Altere o nome da planta para evitar conflitos durante o registro do Blueprint
   • Limite as plantas para aceitar webhooks apenas de um aplicativo Git ou múltiplos
   • Limite as plantas para aceitar webhooks de entrada apenas da IPS de Whitelisted
   • Altere o comando usado para invocar o Git (PullerwebhookbluePrint)
   • Altere o ambiente do sistema operacional usado pelos processos infantis Git (PullerwebhookbluePrint)
2. Alterações mais avançadas exigem a criação de uma subclasse do WebHookBluePrint, isso não é tão assustador. Existem dois métodos na classe: receiveWebhook e processWebhook . Substitua o primeiro a mudar a maneira como a solicitação bruta é tratada e verificada. Substitua o último para alterar o que é feito quando o webhook for verificado.

Licença

Este trabalho é licenciado sob a licença do MIT.