Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominiquebertrand/cloud-testing-agent
The Cloud Testing Agent is a purpose-built tool crafted for the testing of Coog cloud application services. Its design enables seamless integration with the entire application delivery pipeline within the Coopengo cloud application platform.
https://github.com/dominiquebertrand/cloud-testing-agent
cloud coog postman services
Last synced: about 2 months ago
JSON representation
The Cloud Testing Agent is a purpose-built tool crafted for the testing of Coog cloud application services. Its design enables seamless integration with the entire application delivery pipeline within the Coopengo cloud application platform.
- Host: GitHub
- URL: https://github.com/dominiquebertrand/cloud-testing-agent
- Owner: DominiqueBertrand
- License: mit
- Created: 2023-07-07T14:39:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-20T18:34:06.000Z (8 months ago)
- Last Synced: 2024-10-30T16:20:37.400Z (2 months ago)
- Topics: cloud, coog, postman, services
- Language: TypeScript
- Homepage:
- Size: 13 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[
](https://www.npmjs.com/package/cloud-testing-agent)
## Description
The **Cloud Testing Agent** is a purpose-built tool crafted for the **testing** of **Coog cloud application services**. Its design enables seamless integration with the entire application delivery pipeline within the Coopengo cloud application platform.
## Table of Contents
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Running the app](#running-the-app)
- [Test](#test)
- [Swagger Documentation](#swagger-documentation)
- [Custom variables](#custom-variables)
- [Seeding](#seeding)
- [Releases](#releases)
- [SonarQube](#sonarqube)
- [Execute the Scanner](#execute-the-scanner)
- [Generate pre-scan reports](#generate-pre-scan-reports)
- [Run the scan](#run-the-scan)
- [Docker](#docker)
- [How to generate docker image thanks to the following command](#how-to-generate-docker-image-thanks-to-the-following-command)
- [How to run cloud-testing-agent docker image](#how-to-run-cloud-testing-agent-docker-image)
- [License](#license)
## Installation
Install dependencies
```bash
$ yarn install
```
Enable environment variables using the shell extension [direnv](https://direnv.net/):
```bash
$ cp .envrc.example .envrc
$ direnv allow
```
Please be aware that if your database hasn't undergone the initialization process, specifically with regards to the 'user' table, it's essential to perform a pre-initialization step. This entails the creation of two user accounts: one as a super administrator named 'superadmin,' and the other as a user named 'coog.' Ensure that 'coog' is granted permissions to read, create, delete, and update all database objects except for the 'user' table.
See section [Seeding](#seeding) below.
## Running the app
```bash
# Development - Start application
$ yarn start
# Watch mode - Start application in watch mode
$ yarn start:dev
# Production mode - Start built application
$ yarn start:prod
```
By default, the application is running to http://localhost:3000
## Test
```bash
# unit tests
$ yarn test
# e2e tests
$ yarn test:e2e
# test coverage
$ yarn test:cov
```
## Swagger Documentation
By default, while the application is running, open your browser and navigate to http://localhost:3000/api to see the Swagger UI:
[](screencapture-127-0-0-1-7000-api-2024-02-06-11_27_38.png)
## Custom variables
By default, th application running to the port 3000, but you can customize this value thanks to the variable `SERVER_PORT`
```bash
export SERVER_PORT=7000
```
## Seeding
Seeding is used to insert data into the database. The seeding files are stored in `modules/orm/seeders` directory.
```sh
npx cross-env NODE_ENV=dev yarn orm seeder:run # seeds data
```
## Releases
When a commit to the main branch has Release-As: x.x.x (case insensitive) in the commit body, [Release Please](https://github.com/googleapis/release-please) will open a new pull request for the specified version.
Empty commit example:
```sh
git commit --allow-empty -m "chore: release 0.2.0" -m "Release-As: 0.2.0"
```
results in the following commit message:
```sh
chore: release 2.0.0
Release-As: 2.0.0
```
## SonarQube
### Execute the Scanner
Running a SonarQube analysis is straighforward. Locally, you just need to execute the following commands in your project's folder.
### Generate pre-scan reports
Generate unit test coverage report
```sh
yarn test:cov
```
Generate security vulnaribility report
```sh
./scripts/dependency-check.sh -f ALL -s . --out reports/dependency-check --project "coog-cloud-agent"
```
## Run the scan
```sh
sonar-scanner \
-Dsonar.projectKey=$SONARQUBE_PROJECT_KEY \
-Dsonar.sources=$SONARQUBE_REPO \
-Dsonar.host.url=$SONARQUBE_URL \
-Dsonar.token=$SONARQUBE_TOKEN
```
or thanks to the following docker command :
```sh
docker run \
--rm \
-e SONAR_HOST_URL="$(SONARQUBE_URL)" \
-e SONAR_SCANNER_OPTS="-Dsonar.projectKey=$(SONARQUBE_PROJECT_KEY)" \
-e SONAR_TOKEN="$(SONARQUBE_TOKEN)" \
-v "$(SONARQUBE_REPO):/usr/src" \
sonarsource/sonar-scanner-cli
```
## Docker
## How to generate docker image thanks to the following command
To build:
```console
docker build --file ./build/Dockerfile --no-cache --progress=plain -t cloud-testing-agent:latest -t cloud-testing-agent:{{VERSION}} . |& tee build_output.txt
```
### How to run cloud-testing-agent docker image
Before starting the service, we will create a network for our container, so you can more easily choose which one to use and when.
```console
docker network create cloud-coopengo
```
To run:
```console
docker compose -f "./build/compose.yaml" -p "cloud-testing" up --force-recreate -d
```
The service will be available at http://0.0.0.0:3000/ .
## License
Nest is [MIT licensed](LICENSE).