Desafio Full Stack Dev Chaordic

Dependências do Projeto

• NGINX
• GUnicorn
• Python 3.6
  • Flask 0.12.2
  • short_url 1.2.2
  • sqlite3 (inclusa nas bibliotecas padrão do Python)

Arquitetura

Este webservice foi desenvolvido utilizando o micro-framework Flask. Os endpoints RESTful são tratados por essa biblioteca Python, enquanto a camada de dados é tratada pelo database engine SQLite (integrado aos módulos do Python 3 sob o nome sqlit3). Essas duas tecnologias foram escolhidas pela sua simplicidade de desenvolvimento e aplicação, assim diminuindo o tempo de desenvolvimento e facilitando o entendimento do código.

Apesar do Flask ter um servidor interno, o uso do mesmo em ambientes de produção não é recomendado. Para solucionar esse problema foi utilizado o stack de tecnologias NGINX + GUnicorn. O NGINX recebe as requisições, encaminha-as ao GUnicorn, que por sua vez as entrega ao app Flask para processamento.

Funcionamento

O tratamento das requisições HTTP se dá da seguinte forma:

1. A requisição é recebida pelo NGINX
2. O NGINX redireciona o tráfego para o endereço localhost:8000
3. Uma instância do GUnicorn capta a requisição e encaminha para o app em Python e
4. O framework Flask encaminha a requisição para o método Python adequado
5. O pedido é processado, e é retornada a resposta adequada a requisição
   • Pedidos que necessitem de acesso ao banco são tratados pela biblioteca sqlite3

Instalação

Para instalar a aplicação, e todas as suas dependências, basta apenas rodar o shell script install.sh, localizado na pasta setup.

Executando a Aplicação

Para iniciar os servidores e passar a escutar requisições, basta apenas rodar o shell script start.sh, localizado no diretório root deste projeto.

Nota: O script inicia o GUnicorn com 4 workers destinados a aplicação. Caso se deseje alterar esse número, a seguinte linha do arquivo deve ser modificada:

sudo gunicorn -w 4 -b localhost:8000 main:app

Testes Automatizados

Os testes unitários estão separados em dois arquivos: unit_test e test_global_stats, localizados na pasta tests. A separação se deu por conta da impossibilidade de sequenciar os testes unitário de maneira confiável (utilizando a biblioteca unittests do Python).

É necessário instalar a biblioteca Python Requests para rodar os testes, para isso use o comando abaixo:

    sudo pip3 install requests

Os arquivos podem ser executados em qualquer ordem. Preferencial execute os testes antes de realizar operações manualmente, contudo não devem ocorrer erros caso se realize operações antes dos testes.

Abaixo uma descrição dos arquivos:

• test_global_stats: Executa um teste para verificar a integridade das informações das estatísticas globais;
• unit_test: Executa testes diversos com as funcionalidades, como:
  • Inserir e deletar usuário;
  • Inserir e deletar URL;
  • Verificar estatísticas de usuário;
  • Teste de redireção e verificação de contagem de hits na URL;
  • Verificação de teapot (not a coffee machine).

NOTA:: É necessário alterar o endereço das requisições HTTP nos arquivos de teste, de "130.211.125.185" para o endereço do servidor onde a aplicação foi instalada por você.

Caso contrário, as solicitações HTTP serão enviadas para uma máquina virtual da Google Cloud (Compute Engine), com Ubuntu 14.04 LTS instalado. A máquina em questão está rodando uma instância deste webservice, e atenderá aos pedidos HTTP enviados aos endpoints.