go-fundamentals

Projeto de estudo dos fundamentos de GoLang, baseado no curso de Imersão Técnica - Go Fundamentals, promovido pela academia (https://platform.rocks/).

Descrição

Este projeto é uma aplicação CLI (Command Line Interface) em Go que permite gerenciar configurações de servidores e bancos de dados através de arquivos YAML ou JSON. Utiliza a biblioteca Cobra para construção da interface de linha de comando.

Requisitos

• Ter o Go instalado na máquina (https://go.dev/doc/install).
• Docker (opcional, para execução em container)

Estrutura do Projeto

├── cmd/                   # Comandos da CLI
│   ├── root.go            # Comando raiz
│   ├── parse.go           # Comando para parsing de configurações
│   └── server.go          # Comando para gerenciar servidores
├── config/                # Pacote de configuração
│   ├── config.go          # Lógica de carregamento de configurações
│   ├── types.go           # Tipos de dados das configurações
│   └── config_test.go     # Testes do pacote config
├── bin/                   # Diretório para binários compilados
├── example_config.yaml    # Exemplo de arquivo de configuração
├── Dockerfile             # Configuração do Docker
├── Makefile               # Comandos de build e execução
└── main.go                # Ponto de entrada da aplicação

Instalação

Compilar a aplicação

make build

Executar diretamente com Go

go run main.go [comando] [flags]

Comandos Disponíveis

Comando parse

Lê e valida um arquivo de configuração em formato YAML ou JSON.

# Usando o binário compilado
./bin/configparser parse --file example_config.yaml

# Usando go run
go run main.go parse --file example_config.yaml

# Usando Makefile
make run

Comando server

Gerencia configurações de servidores.

# Usando o binário compilado
./bin/configparser server --file example_config.yaml

# Usando go run
go run main.go server --file example_config.yaml

Ajuda

Para ver todas as opções disponíveis:

go run main.go --help
go run main.go parse --help
go run main.go server --help

Exemplo de Arquivo de Configuração

O arquivo example_config.yaml contém um exemplo de configuração:

servers:
  - name: server1
    host: 127.0.0.1
    port: 8080
    replicas: 3
database:
  host: localhost
  port: 5432
  user: admin
  password: secret

Comandos Make Disponíveis

Comando	Descrição
make build	Compila a aplicação
make run	Executa a aplicação com o arquivo de exemplo
make test	Executa os testes
make clean	Remove arquivos compilados
make docker-build	Constrói a imagem Docker
make docker-run	Executa a aplicação no Docker

Execução com Docker

Construir a imagem

make docker-build

Executar no container

make docker-run

Testes

Para executar os testes:

make test

CI/CD Pipeline

O projeto possui pipelines automatizadas no GitHub Actions que são executadas:

• CI Pipeline: Executa a cada push/PR nas branches main e develop

  • Testa o código em múltiplas versões do Go (1.22, 1.23, 1.24)
  • Executa testes com coverage
  • Faz build da aplicação
  • Executa linting com golangci-lint
  • Faz análise de segurança com gosec

• Release Pipeline: Executa quando uma tag é criada

  • Faz build para múltiplas plataformas (Linux, macOS, Windows)
  • Cria release automaticamente no GitHub

Para criar um release:

git tag v1.0.0
git push origin v1.0.0

To Do

• Criar um parser de arquivos de configurações do tipo JSON e YAML utilizando a lib Cobra para construção de um CLI.
• Implementar validação de configurações
• Adicionar suporte a Docker
• Criar comandos separados para parse e server
• Configurar CI/CD Pipeline com GitHub Actions
• Adicionar linting automatizado com golangci-lint
• Implementar análise de segurança com gosec
• Configurar pipeline de release automático
• Adicionar mais validações específicas
• Implementar comando para database
• Adicionar testes unitários mais abrangentes
• Melhorar tratamento de erros
• Adicionar logging estruturado
• Implementar cache de configurações
• Adicionar métricas de performance

Licença

Este projeto é licenciado sob a licença MIT - veja o arquivo LICENSE para detalhes.