Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/felipementel/deploy.cachorro.api

API criada para o canal DEPLOY para fins de estudo
https://github.com/felipementel/deploy.cachorro.api

application-insights azure azure-app-configuration azure-application-insights azure-container-apps azure-container-instances azure-container-registry azure-key-vault azure-sql-database docker docker-compose docker-hub ef entity-framework-core github-actions net openapi3 swagger wsl-2 xunit

Last synced: 10 days ago
JSON representation

API criada para o canal DEPLOY para fins de estudo

Host: GitHub
URL: https://github.com/felipementel/deploy.cachorro.api
Owner: felipementel
License: apache-2.0
Created: 2023-08-24T23:30:51.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-09T14:25:52.000Z (7 months ago)
Last Synced: 2024-04-10T02:05:24.039Z (7 months ago)
Topics: application-insights, azure, azure-app-configuration, azure-application-insights, azure-container-apps, azure-container-instances, azure-container-registry, azure-key-vault, azure-sql-database, docker, docker-compose, docker-hub, ef, entity-framework-core, github-actions, net, openapi3, swagger, wsl-2, xunit
Language: C#
Homepage:
Size: 1.11 MB
Stars: 14
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

# DEPLOY.Cachorro.Api

![Imagem projeto api de cachorro](./docs/imgreadme1.png)

[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=felipementel_DEPLOY.Cachorro.Api)](https://sonarcloud.io/summary/new_code?id=felipementel_DEPLOY.Cachorro.Api)
![actions.](https://github.com/felipementel/DEPLOY.Cachorro.Api/actions/workflows/push-image.yaml/badge.svg?branch=main)

# Configuração local do Git

```
git config --local --list
```

```
git config --local user.name "Felipe Augusto"
```

```
git config --local user.email [email protected]
```

```

git fetch origin --prune

```

Projeto educacional, criado e mantido através do canal DEPLOY no YouTube.

> Para criar a imagem, a partir do diretório root da aplicação (pasta que contem o arquivo sln)

# pre-requisitos para executar o projeto

1. Docker
2. Um conta no Azure para criar recursos

> Para executar o projeto local:

```
dotnet run --project ./src/DEPLOY.Cachorro.Api/DEPLOY.Cachorro.Api.csproj ASPNETCORE_ENVIRONMENT=aaa ConnectionStrings:ApplicationInsights="bbb" ConnectionStrings:DefaultConnection="ccc" ConnectionStrings:AppConfiguration="ddd"
ApplicationInsights:ApiKey="eee" KeyVault:VaultUri="fff"
```

> Para executar o projeto local, utilizando docker

```
docker container run --rm -p 8088:80 \
-e ASPNETCORE_ENVIRONMENT=aaa \
-e ConnectionStrings__ApplicationInsights="bbb" \
-e ConnectionStrings__DefaultConnection="ccc" \
-e ConnectionStrings__AppConfiguration="ddd" \
-e ApplicationInsights__ApiKey="eee" \
-e KeyVault__VaultUri="fff" \
-e AzureAd__Instance="https://login.microsoftonline.com" \
-e AzureAd__ClientId="ggg" \
-e AzureAd__TenantId="hhh" \
felipementel/cachorro.api:latest
```

```
aaa = Development|Production
bbb = ConnectionString do Application Insights
ccc = Connection String (Azure SQL Database ou https://hub.docker.com/_/microsoft-azure-sql-edge)
ddd = Connection string do App Configuration
eee = ApiKey gerada dentro do Application Insights
fff = URI do Azure KeyVault
ggg = Identificador do cliente criado no Entra ID
hhh = Identificador do Tenant
```

Comando para subir o banco de dados local:

```
docker run --cap-add SYS_PTRACE -e 'ACCEPT_EULA=1' -e 'MSSQL_SA_PASSWORD=Abcd1234%' -e 'MSSQL_PID=Developer' -p 1433:1433 --name azuresqledge -d mcr.microsoft.com/azure-sql-edge:2.0.0
```

Caso queira testar com outra tag, utilize os comandos abaixo para obter a lista de tags

```
https://mcr.microsoft.com/v2/azure-sql-edge/tags/list
```

# Testes de unidade

Tecnologia: XUnit

0. Pre requisito
Será necessário instalar os dois pacotes abaixo para ter sucesso ao executar os comandos descritos nesse arquivo.

```
dotnet tool install --global dotnet-reportgenerator-globaltool
```

```
dotnet tool install --global dotnet-coverage
```

1. Como Executar:
1.1 A partir da pasta src execute o comando:

```
dotnet test
```

2. Geração de relatório de testes

1.1 A partir da pasta src execute o comando:

```
dotnet test --collect:"XPlat Code Coverage" --logger "console;verbosity=detailed" --results-directory ..\TestResults\XPlatCodeCoverage\
```

e depois execute:

```
reportgenerator -reports:..\TestResults\XPlatCodeCoverage\**\coverage.cobertura.xml -targetdir:..\TestResults\XPlatCodeCoverage\CoverageReport -reporttypes:"Html;SonarQube;JsonSummary;Badges" -classfilters:"-*.Migrations.*" -verbosity:Verbose -title:Cachorro.API -tag:canal-deploy
```

```
$var = (Get-Date).ToString("yyyyMMdd-HHmmss"); dotnet-coverage collect "dotnet test" -f xml -o "..\TestResults\DotnetCoverageCollect\$var\coverage.cobertura.xml"
```

e depois execute:

```
reportgenerator -reports:..\TestResults\DotnetCoverageCollect\**\coverage.cobertura.xml -targetdir:..\TestResults\DotnetCoverageCollect\CoverageReport -reporttypes:"Html;SonarQube;JsonSummary;Badges" -verbosity:Verbose -title:Cachorro.API -tag:canal-deploy
```

1.2 A partir da pasta src execute o comando:

# Ambiente Local

## SonarQube

1. Comandos para submeter o código ao sonarqube do Container

```
dotnet sonarscanner begin /k:"CachorroAPI" /d:sonar.host.url="http://localhost:9044" /d:sonar.token="xxxxx" /d:sonar.cs.vscoveragexml.reportsPaths=coverage.xml /d:sonar.exclusions="**/Migrations/**"
```

```
dotnet restore .\src\DEPLOY.Cachorro.Api\DEPLOY.Cachorro.Api.csproj
```

```
dotnet build .\src\DEPLOY.Cachorro.Api\DEPLOY.Cachorro.Api.csproj --no-incremental
```

```
dotnet-coverage collect 'dotnet test ./src/' -f xml -o 'coverage.xml'
```

```
dotnet-sonarscanner end /d:sonar.token="xxxxx"
```

---

# EntityFramework Commands

```

dotnet tool install --global dotnet-ef

```

dotnet ef migrations add InitDatabaseAPI -s DEPLOY.Cachorro.Api -p DEPLOY.Cachorro.Infra.Repository -c DEPLOY.Cachorro.Infra.Repository.CachorroDbContext --output-dir Migrations/API -v

```

dotnet ef database update InitDatabaseAPI --startup-project DEPLOY.Cachorro.Api --project DEPLOY.Cachorro.Infra.Repository --context DEPLOY.Cachorro.Infra.Repository.CachorroDbContext --verbose

```

Connection String

```

Data Source=127.0.0.1,1433;Initial Catalog=Cachorro;User Id=sa;Password=Abcd1234%;Integrated Security=False;MultipleActiveResultSets=True;TrustServerCertificate=true;

```

# Azure Entra ID

```

https://learn.microsoft.com/en-us/entra/identity-platform/v2-overview
```

```
https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app
```

```
https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc
```

```

https://learn.microsoft.com/en-us/entra/identity-platform/scenario-protected-web-api-app-configuration?tabs=aspnetcore#bearer-token

```

https://learn.microsoft.com/en-us/entra/identity-platform/scenario-web-app-sign-user-app-configuration?tabs=aspnet

```

## Link de documentações citadas durante a criaçao do projeto

```
https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet
```

```

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-7.0

```

```
https://learn.microsoft.com/en-us/dotnet/core/compatibility/containers/8.0/app-user

```

https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-7.0&tabs=windows

```

### Github

```
https://docs.github.com/en/actions

```

```
https://github.com/danielpalme/ReportGenerator
```

```
https://github.com/marketplace/actions/reportgenerator
```

### ILogger

```

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-7.0

```

https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-test

```

https://learn.microsoft.com/en-us/azure/azure-monitor/app/ilogger?tabs=dotnet6

```

### Application Insights

```

https://learn.microsoft.com/pt-br/azure/azure-monitor/app/asp-net-core?tabs=netcorenew%2Cnetcore6

```

Live Stream / Live Metrics

```

https://learn.microsoft.com/en-us/azure/azure-monitor/app/live-stream?tabs=dotnet6

```

### Key Vault

```

https://learn.microsoft.com/pt-br/azure/key-vault/general/basic-concepts

```

```
https://learn.microsoft.com/en-us/dotnet/azure/sdk/dependency-injection?tabs=web-app-builder
```

```
https://learn.microsoft.com/pt-br/aspnet/core/security/key-vault-configuration?view=aspnetcore-3.1
```

### Configuration

```

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-7.0

```

### SonarQube

```

https://docs.sonarsource.com/sonarcloud/advanced-setup/analysis-parameters/

```

### Azure App Configuration

```

https://learn.microsoft.com/en-us/azure/azure-app-configuration/quickstart-aspnet-core-app?tabs=core6x
```

```
https://learn.microsoft.com/en-us/azure/azure-app-configuration/howto-feature-filters-aspnet-core
```

```
https://learn.microsoft.com/en-us/azure/azure-app-configuration/enable-dynamic-configuration-aspnet-core?tabs=core6x

```

### Docker Commands

```

docker container rm -f $(docker container ls -a -q)

```

docker volume rm $(docker volume ls -q)

```

docker image rm -f $(docker image ls -a -q)

```

docker system prune

```

docker image ls

```

docker build -f ./src/DEPLOY.Cachorro.Api/Dockerfile -t felipementel/cachorro.api:local ./src

```

docker tag 430f5d9f4229 crcanaldeploydev.azurecr.io/cachorro.api:latest

```

docker push crcanaldeploydev.azurecr.io/cachorro.api:latest

```

docker push ghcr.io/felipementel/cachorro.api:latest

```

docker container run -p 8088:80 crcanaldeploydev.azurecr.io/cachorro.api:latest

```

docker container run --rm --name sonar-canal-deploy -p 9044:9000 sonarqube:10.3.0-community

```

### Comandos Azure Key Vault

```

az keyvault secret show --name CachorroConnectionString --vault-name kv-canaldeploy-dev

```

@Microsoft.KeyVault(SecretUri=https://kv-canaldeploy-dev.vault.azure.net/secrets/ConnectionStrings--ApplicationInsights/)

```

@Microsoft.KeyVault(VaultName=kv-canaldeploy-dev;SecretName=ConnectionStrings--ApplicationInsights)

```

### Comandos Azure Container Instance

```

az container logs --resource-group rg-canaldeploy-dev --name api-cachorro

```

az container exec -g g-canaldeploy-dev --name cachorro.api --exec-command "/bin/bash"

```

#git
#github
#github-actions
#sonar-qube
#wsl-2
#docker
#docker-compose
#docker-hub
#donet
#ef-core
#entity-framework-core
#x-unit
#postman
#azure
#azure-application-ingishts
#azure-sql-database
#azure-app-configuration
#azure-container-registry
#azure-container-instance
#azure-container-apps
#azure-key-vault