Merge pull request #1 from Tech-Preta/develop

Develop

.gitignore

@@ -0,0 +1,2 @@
+tests/__pycache__
+.vscode

README.md

@@ -31,4 +31,18 @@ Para executar o script, você pode usar o seguinte comando:
 python3 analise-de-custos.py
 ```
 
+Ou
+
+```
+python3 -m analise_de_custos
+```
+
 O script irá solicitar que você insira as datas de início e término para a análise de custos. As datas devem ser inseridas no formato AAAA-MM-DD. Em seguida, o script irá listar os custos dos serviços AWS para o período de tempo especificado.
+
+## Extras
+
+- 1. **Executando o teste**:
+
+```
+python3 -m unittest tests.test_analise_de_custos
+```

__init__.py

@@ -0,0 +1,16 @@
+"""
+Este é o módulo principal do projeto aws_cost_py.
+Ele importa e executa as funções do módulo analise_de_custos.
+"""
+
+from .analise_de_custos import get_custom_date_range, list_costs_by_service
+
+def main():
+    """
+    Função principal que solicita ao usuário um intervalo de datas e lista os custos dos serviços AWS para esse intervalo.
+    """
+    start_date, end_date = get_custom_date_range()
+    list_costs_by_service(start_date, end_date)
+
+if __name__ == "__main__":
+    main()

analise-de-custos.py → analise_de_custos.py

@@ -1,14 +1,24 @@
-import boto3
+"""
+Este é o módulo analise_de_custos.
+Ele contém funções para analisar os custos dos serviços AWS.
+"""
 import datetime
+import boto3
 
 # Configuração do cliente boto3
 ce_client = boto3.client('ce', region_name='us-east-1')  # Substitua 'us-east-1' pela sua região
 
 # Taxa de câmbio da AWS para converter para BRL
-currency_conversion_rate = 5.50  # Substitua pelo valor da taxa de câmbio atual
+CURRENCY_CONVERSION_RATE = 5.50  # Substitua pelo valor da taxa de câmbio atual
 
 # Função para obter o período desejado de forma interativa
 def get_custom_date_range():
+
+    """
+    Solicita ao usuário que insira as datas de início e término para a análise de custos.
+    As datas devem ser inseridas no formato AAAA-MM-DD.
+    """
+
     print("Digite o período desejado para análise de custos:")
     start_date_str = input("Data de início (AAAA-MM-DD): ")
     end_date_str = input("Data de término (AAAA-MM-DD): ")
@@ -20,9 +30,19 @@ def get_custom_date_range():
     except ValueError:
         print("Formato de data inválido. Use o formato AAAA-MM-DD.")
         return get_custom_date_range()
+    except KeyboardInterrupt:
+        print("\nExecução interrompida pelo usuário.")
+        return None
 
 # Função para obter e listar os serviços e valores de gastos
 def list_costs_by_service(start_date, end_date):
+    """
+    Obtém e lista os custos dos serviços AWS para o período de tempo especificado.
+    """
+
+    if not start_date or not end_date:
+        return
+
     response = ce_client.get_cost_and_usage(
         TimePeriod={
             'Start': start_date.strftime('%Y-%m-%d'),
@@ -42,9 +62,10 @@ def list_costs_by_service(start_date, end_date):
         for group in result['Groups']:
             service_name = group['Keys'][0]
             cost = float(group['Metrics']['BlendedCost']['Amount'])
-            cost_brl = cost * currency_conversion_rate
-            print(f"Serviço: {service_name}, Custo em USD: ${cost:.2f}, Custo em BRL: R${cost_brl:.2f}")
+            cost_brl = f"{cost * CURRENCY_CONVERSION_RATE:.2f}"
+            print(f"Serviço: {service_name}, Custo em USD: ${cost:.2f}, Custo em BRL: R${cost_brl}")
 
 if __name__ == '__main__':
     start_date, end_date = get_custom_date_range()
-    list_costs_by_service(start_date, end_date)
+    if start_date and end_date:
+        list_costs_by_service(start_date, end_date)

tests/test_analise_de_custos.py

@@ -0,0 +1,18 @@
+"""
+Este é o módulo de teste para o módulo analise_de_custos.
+Ele contém testes unitários para as funções get_custom_date_range e list_costs_by_service.
+"""
+
+import unittest
+from analise_de_custos import get_custom_date_range
+
+class TestAnaliseDeCustos(unittest.TestCase):
+    """
+    Esta classe contém testes unitários para o módulo analise_de_custos.
+    """
+
+    def test_get_custom_date_range_valid_input(self):
+        """
+        Testa a função get_custom_date_range com uma entrada válida.
+        """
+        input_start_date, input_end_date = get_custom_date_range()