Inclusão de build.yml para sonar;

Atualização de README.md e docs;
Atualização de gitignore para permitir relatórios de cobertura;
Inclusão de versão do projeto no projectrc

Author: andersoncontreira

.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Build
+on:
+  push:
+    branches:
+      - production
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -17,15 +17,22 @@ venv
 /docker/elk/logs/elasticsearch.log
 /.infrastructure/.terraform/
 /.chalice/deployments/
-/target/
-/target/dynamodb-local/
 *_us-east-2.db
 *_sa-east-1.db
 /docker/aws/credentials
 /deployment.zip
 /sam.json
 /.coverage
 
+# mantem a vendor
+!vendor
+# ignora os demais arquivos
+vendor/*
+# mantem essa pasta
+!/vendor/public
+# mantem essa pasta
+!/vendor/datasources
+
 # Coverage results and execution report
 !/target/integration/report.xml
 !/target/component/report.xml
@@ -50,9 +57,16 @@ imagedefinitions.json
 config/integration.en
 /node_modules/
 
-/examples/lambda_api/vendor/*
-/examples/lambda_cron/vendor/*
-/examples/lambda_s3/vendor/*
-/examples/lambda_sns/vendor/*
-/examples/lambda_sqs/vendor/*
-/vendor/
+/lambda-full.zip
+
+#output lambda
+output/response.json
+/output/
+/include/
+/life-cycle-service-manager-recovery.zip
+/env/integration.env
+/env/production.env
+/env/staging.env
+/env/_staging.env
+/env/_integration.env
+/env/_production.env

README.md

@@ -1,18 +1,64 @@
 # template-serverless-lambda-python
 This project contains isolated examples of AWS Lambda Services as well this provide
 a stack example.
+[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint)
+[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=madeiramadeirabr_template-serverless-lambda-python&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=madeiramadeirabr_template-serverless-lambda-python)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=madeiramadeirabr_template-serverless-lambda-python&metric=coverage)](https://sonarcloud.io/summary/new_code?id=madeiramadeirabr_template-serverless-lambda-python)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=madeiramadeirabr_template-serverless-lambda-python&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=madeiramadeirabr_template-serverless-lambda-python)
 
 ## Service Architecture
-Example of architecture of this project stack.
+Diagrams with application usage of this architecture.
+
+More details [here](https://drive.google.com/file/d/112om-id0zfd8qGd0Q4kTaoIwIgwx6DGJ/view?usp=sharing).
+
+### Cloud Architecture
+Example of the architecture running on AWS Cloud.
+
 ![Service-Arch](docs/service-arch.png)
 
-## Service Stack
-Example of components of the architecture of this project.
-![Service-Stack](docs/service-stack.png)
+### Docker Architecture
+Example of the architecture running with docker.
+![Docker-Service-Arch](docs/service-stack.png)
+
+## General Service Routes Architecture
+Example of OpenApi documentation.
+![Swagger](docs/swagger.png)
+
+Route list:
+```
+GET / - Root
+GET /docs - Swagger docs
+GET /alive - Health Check
+GET /v1/event/<event_type> - Event List
+POST /v1/event/<event_type> - Create Event
+```
+
+# Prerequisites
+- Python >=3.6
+- docker
+- docker-compose
+- python-dotenv
+- jsonformatter
+- requests
+- pytz
+- redis
+- pyyaml
+- apispec
+- marshmallow
+- Flask
+
+## Features
+- Docker-compose 
+- Localstack
+- SQS Integration
+- Flask
+- MySQL
+- Redis
 
 ## Build environment script workflow
 Example of the workflow to create the environment.
-![Service-Stack](docs/runenv-workflow.drawio.png)
+![Runenv-Workflow](docs/runenv-workflow.drawio.png)
 
 ## Single project examples
 
@@ -31,20 +77,42 @@ You can find complex examples:
 * [Lambda SNS](./examples/lambda_sns)
 * [Lambda S3](./examples/lambda_s3)
 
+## Details about requirements files
+### requirements.txt
+Collection of common application modules, light modules.
+
+### requirements-vendor.txt
+Collection of specific application modules, heavy modules that can be converted to layers if necessary.
 
-## Stack
-* AWS Lambda
-* Flask for APIs
-* Custom code based in AWS Chalice for SQS, SNS, S3 and CRON
+### requirements-tests.txt
+Collection of specific test application modules.
 
-## Prerequisites
-* Docker
-* Docker-compose
-* Python 3.x
 
 ## Installation
-### Creating the virtual env
-To create the venv and install the modules execute:
+### Installing AWS CLI
+Documentation:
+https://docs.aws.amazon.com/pt_br/cli/latest/userguide/install-cliv2.html
+
+Execute the follow command:
+```bash
+apt install python38-env
+apt install awscli
+apt install zip
+app install pip
+```
+Execute the follow command:
+```bash
+aws configure
+```
+
+### Installing python venv support
+Execute the follow command:
+```bash
+apt install python38-env
+```
+
+### Running Locally
+To create the `venv` and install the modules execute:
 ```bash
 ./scripts/venv.sh
 ```
@@ -54,12 +122,64 @@ To execute the build:
 ```bash
 ./scripts/runenv.sh --build
 ```
+
 Execute the follow command:
 ```bash
 ./scripts/runenv.sh
 ```
-### Boot the resources
+
+### Recovering the environment in error cases
 Execute the follow command:
 ```bash
-./scripts/boot.sh
+./scripts/fixenv.sh
 ```
+
+## Automation scripts information
+Bellow we describe the usage of the automation scripts.
+These kebab case scripts helps the developer in general tasks.
+
+### General scripts
+Kebab case script to help the developer in general tasks.
+
+| Script                      | Description                                                                       | Context           |
+|-----------------------------|-----------------------------------------------------------------------------------|-------------------|
+| autopep8.sh                 | Execute the code-lint for pep8                                                    | Codelint          |
+| boot.sh                     | Boot the application during de container execution                                | Local boot        |
+| boot-db.sh                  | Boot the data for the database                                                    | Local boot        |
+| boot-queues.sh              | Boot the queues of the application in the localstack                              | Local boot        |
+| boot-validate-connection.sh | Check if localstack is ready to connect                                           | Local boot        | 
+| clean-env.sh                | Clean the ./vendor folder                                                         | Local install     |
+| fixenv.sh                   | In some cases where the network are deleted, you can fix the container references | Local install     |
+| install.sh                  | Script to install the dependencies                                                | Local install     |
+| install-local.sh            | Script to install the dependencies in the ./vendor folder                         | Local install     |
+| openapi.sh                  | Script to generate the openapi.yaml                                               | CI/CD pipeline    |
+| preenv.sh                   | Script to execute the pre build commands                                          | Local boot        |
+| pylint.sh                   | Script to execute the pylint analysis                                             | Local development |
+| runenv.sh                   | Script to start the project locally                                               | Local development |
+| testenv.sh                  | Script to run the environment with focus in the component tests                   | Local development |
+| venv.sh                     | Script to install the dependencies in the venv folder                             | Local install     |
+| venv-exec.sh                | Script to execute scripts to install content inside the venv                      | Local install     |
+| zip.sh                      | Generate a zip file with the application content                                  | Other             |
+
+### Docker scripts
+Helper scripts to do tasks for docker context;
+### Flask scripts
+Helper scripts to run flask locally, not inside a docker container;
+### Localstack scripts
+Helper scripts to run commands over Localstack resources like S3, SQS, Lambda, etc;
+### Migrations scripts
+Helper scripts to execute migrations;
+### OpenApi scripts
+Helper scripts to generate openapi schemas and specifications;
+### Tests scripts
+Helper scripts to execute tests and generate reports;
+
+## Samples
+See the project samples in this folder [here](samples).
+
+
+## License
+See the license: [LICENSE.md](LICENSE.md).
+
+## Contributions
+* Anderson de Oliveira Contreira [andersoncontreira](https://github.com/andersoncontreira)

docker-compose.yml

@@ -1,9 +1,8 @@
 version: "3.2"
 services:
-  template-serverless-lambda-python-lambda-api-resful:
-#    container_name: template-serverless-lambda-python-lambda-api
+  template-serverless-lambda-python-lambda-api:
     build:
-      context: ./examples/lambda_api_restful/
+      context: ./examples/lambda_api/
       dockerfile: ./docker/python/Dockerfile
     privileged: true
     entrypoint: ["sh", "./docker/python/entrypoint.sh"]
@@ -21,7 +20,7 @@ services:
     networks:
       - service-python
     volumes:
-      - ./examples/lambda_api_restful/:/app
+      - ./examples/lambda_api/:/app
   template-serverless-lambda-python-lambda-sqs:
 #    container_name: template-serverless-lambda-python-lambda-sqs
     build:

docs/swagger.png

@@ -0,0 +1,20 @@
+name: Build
+on:
+  push:
+    branches:
+      - production
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

examples/lambda_api/.github/workflows/build.yml

@@ -17,8 +17,6 @@ venv
 /docker/elk/logs/elasticsearch.log
 /.infrastructure/.terraform/
 /.chalice/deployments/
-/target/
-/target/dynamodb-local/
 *_us-east-2.db
 *_sa-east-1.db
 /docker/aws/credentials
@@ -71,5 +69,4 @@ output/response.json
 /env/staging.env
 /env/_staging.env
 /env/_integration.env
-/env/_production.env
-
+/env/_production.env

examples/lambda_api/.gitignore

@@ -1,6 +1,7 @@
 APP_NAME=template-serverless-lambda-python-lambda-api
+APP_VERSION=1.0.0
 NETWORK_NAME=service-python
 APP_QUEUE=test-queue
 APP_LAMBDA_NAME=lambda_api
 APP_LAMBDA_EVENT_SOURCE=false
-APP_PORT=5001
+APP_PORT=5000