c14-np1 0.1.6

Projeto da matéria de Engenharia de Software

Downloader Multithread com GUI

Projeto desenvolvido para a disciplina de Engenharia de Software. A aplicação foi construída em Python com interface em Tkinter e realiza downloads em múltiplas threads, dividindo o arquivo em partes e montando o arquivo final ao término da transferência.

Integrantes

• Guilherme
• Luan Robert

Funcionalidades

• Download de arquivos em múltiplas threads
• Interface gráfica com Tkinter
• Montagem automática do arquivo final
• Geração de logs do processo de download
• Pipeline CI/CD com testes, build, cobertura, deploy e notificação

Estrutura do Projeto

• src/app.py: ponto de entrada da aplicação
• src/downloader/: lógica principal de download, segmentação, rede e IO
• src/gui/: interface gráfica
• tests/: testes unitários
• scripts/send_notification.py: script de envio de e-mail ao final do pipeline
• .github/workflows/cicd.yml: pipeline CI/CD
• pyproject.toml: configuração do pacote Python

Requisitos

• Python 3.9 ou superior
• tkinter disponível no ambiente para execução da interface
• Dependências listadas em requirements.txt

Instalação das dependências:

pip install -r requirements.txt

Instalação do projeto em modo local:

pip install -e .

Como Executar

Depois de instalar o projeto:

c14-np1

Alternativamente, a partir da raiz do projeto:

PYTHONPATH=src python -m app

Como Rodar os Testes

Execução dos testes unitários:

python -m pytest

Execução com geração de relatório JUnit:

python -m pytest --junitxml=report.xml

Cobertura de Testes

O projeto utiliza pytest-cov para gerar relatório de cobertura em HTML.

python -m pytest --cov=downloader --cov=gui --cov=app --cov-report=html

O relatório gerado fica na pasta htmlcov/.

Pipeline CI/CD

O projeto possui um pipeline configurado no GitHub Actions com as seguintes etapas:

1. tests Executa os testes unitários e salva o relatório report.xml como artifact.

2. build Gera a distribuição do pacote Python com python -m build e publica o conteúdo de dist/ como artifact.

3. coverage Executa os testes com cobertura e publica o relatório HTML como artifact.

4. pypi-publish Publica o pacote no PyPI após o sucesso das etapas de build e cobertura.

5. notification Executa um script Python externo para enviar um e-mail com o resumo final do pipeline.

Paralelismo do Pipeline

Após a etapa tests, os jobs build e coverage podem prosseguir de forma independente. Isso atende ao requisito de possuir jobs em paralelo dentro do pipeline.

Artifacts Gerados

• test-report: relatório dos testes unitários
• release-dists: arquivos gerados em dist/
• coverage-report: relatório HTML de cobertura

Deploy

O deploy adotado neste projeto é a publicação do pacote Python no PyPI, caracterizando deploy de artefato de build.

Projeto no PyPI:

• https://pypi.org/project/c14-np1/

Para a publicação automática funcionar, o repositório precisa estar configurado no PyPI como Trusted Publisher ou usar autenticação por token de API.

Observação sobre versionamento

O PyPI não permite sobrescrever versões já publicadas.
Portanto, é necessário incrementar manualmente a versão no arquivo pyproject.toml a cada novo deploy.

Notificação por E-mail

A etapa de notificação utiliza o script send_notification.py e depende dos seguintes secrets no GitHub Actions:

• EMAIL_USER
• EMAIL_PASS
• NOTIFICATION_EMAIL

Opcionalmente, também podem ser definidos:

• SMTP_SERVER
• SMTP_PORT

O script envia um resumo com o status de:

• testes
• build
• cobertura
• deploy

Testes Implementados

O projeto possui mais de 20 cenários de testes unitários cobrindo:

• fluxo principal de segmentação e montagem de arquivos
• formatação e conversão de taxas e tamanhos
• casos de erro e entradas inválidas
• cenários de borda, como valores vazios, zero e ordenação de partes

Arquivos de teste:

• tests/test_segments.py
• tests/test_io_utils.py

Links de Teste

Alguns arquivos públicos que podem ser usados para validar a aplicação:

• 100 MB
• 1 GB
• 10 GB

Uso de IA

Ferramentas de IA foram utilizadas como apoio em diferentes etapas do desenvolvimento do projeto. Abaixo estão os usos reais de prompts e respostas:

---

1. Configuração da Build (pyproject.toml)

Prompt:

Gere um pyproject.toml para build, com campos detalhando oq devo preencher. Apenas envie o arquivo.

Resposta:

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "seu_pacote"            # Nome do pacote
version = "0.1.0"              # Versão
description = "Descrição curta"
authors = [
  { name = "Seu Nome", email = "[e-mail]" }
]
readme = "README.md"
requires-python = ">=3.8"
dependencies = [
  # "numpy>=2.0"
]

Aplicação no projeto: Esse modelo foi utilizado como base para a criação do arquivo pyproject.toml, sendo necessário pesquisa adicional para incluir dependências reais, configuração de pacotes e scripts de execução.

---

2. Erro de Deploy no PyPI

Prompt:

Como resolver este problema de deploy do PyPI, responda objetivamente o motivo e resolução:
Uploading c14_np1-0.1.2-py3-none-any.whl  
INFO Response from https://upload.pypi.org/legacy/: 400 Bad Request  
File already exists ('c14_np1-0.1.2-py3-none-any.whl')

Resposta:

Motivo: O erro ocorre porque você está tentando enviar um arquivo com o mesmo nome e versão que já existe no PyPI. O PyPI não permite sobrescrever artefatos (mesmo que o conteúdo seja idêntico).

Resolução: Você tem 2 opções válidas:

1. Incrementar a versão (recomendado)
   Atualize a versão no projeto (por exemplo, pyproject.toml):

<!-- -->

0.1.2 → 0.1.3

Depois gere e faça o upload novamente.

2. Remover a versão existente (não recomendado)
   Acessar o projeto no PyPI e deletar a release correspondente.

Aplicação no projeto: Essa explicação foi utilizada para definir a estratégia de incremento manual de versão a cada novo deploy para evitar falhas no pipeline CI/CD.

---

3. Uso do GitHub Copilot no VS Code

Ferramenta: GitHub Copilot integrado ao Visual Studio Code.

Uso realizado: Sugestões automáticas de código durante o desenvolvimento, incluindo:

• autocompletar de funções e estruturas básicas
• sugestões de testes unitários com pytest

Aplicação no projeto: As sugestões foram utilizadas para acelerar o desenvolvimento, sendo revisadas e ajustadas antes de serem incorporadas ao código final.