README.md

Repository Scanner Helm Wizard (resc-helm-wizard)

Table of contents

1. About the component
2. Getting started
   • Prerequisites
   • Usage
   • Run helm-values-wizard locally from source
3. Testing
   • Run unit tests, linting and import checks locally

About the component

The helm values wizard is an interactive CLI tool to generate the values yaml file which can be used for helm deployment of RESC. On successful run, this CLI produces custom-values.yaml file in resc-helm-wizard directory.

Getting started

These instructions will help you to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Git
• Python (v3.12.0 or higher)
• Docker Desktop
• Kubernetes
• Helm

Usage

Install the package:

pip install resc-helm-wizard

Run the wizard:

resc-helm-wizard

Run helm-values-wizard locally from source

Run the following commands in a Git Bash or Linux terminal.

Clone the repository:

git clone -b <branch_name> https://github.com/abnamro/repository-scanner.git
cd ./deployment/resc-helm-wizard

Create virtual environment (in Linux/MacOS):

pip install virtualenv
virtualenv venv
source venv/Scripts/activate

Create virtual environment (in Windows):

pip install virtualenv
virtualenv venv
venv/Scripts/activate

Install resc-helm-wizard package:

pip install -e .

Run the resc-helm-wizard CLI (DOES NOT work in git-bash):

resc-helm-wizard

Testing

(Back to top)

Run unit tests, linting and import checks locally:

See below commands for running various (unit/linting) tests locally. To run these tests you need to install tox. This can be done on Linux and Windows with Git Bash.

Run below commands to make sure that the unit tests are running and that the code matches quality standards:

pip install tox         # install tox locally

tox run -e py -v        # Run this command to run the unit tests
tox run -e isort -v     # Run this command to validate the import sorting
tox run -e pylint -v    # Run this command for Python static code analysis
tox run -e flake8 -v    # Run this command for Python linting