Open Source + Windows = Vs Code + Bash + Git

Dans cet article, je vous expose mon setup pour Terraform et Ansible, avec git depuis un poste Windows 10.

Si vous ne connaissez pas encore Git, je vous invite à lire mes articles à ce sujet :

• Git for ops
• Git for ops, le retour Si c’est Visual Studio Code c’est par ici

Et sinon, pour aller plus loin, lisez mon article sur Documentation as Code

Visual Studio Code

Créer un nouveau workspace :

Ouvrez un dossier git ou un vide puis sauvegarder le workspace via “File —> Save workspace as”

Dans la configuration du workspace Crtl + P : ” > Open Workspace Settings”  et ajoutez :

settings: {
"terminal.integrated.shell.windows": "c:\\windows\\System32\\bash.exe"
}

Et relancez VS Code ;)

Configuration de Bash

Il existe pleins de tuto pour installer Bash sur Windows, je ne reviens pas là-dessus, mais voici tout de même un liens vers le store pour un Ubuntu

Je vous donne un petit script bash pour installer les différents packages que j’utilise pour Bash, vous pouvez également installer bash-it :

#!/bin/bash
echo "installation des packages de puis les depots ubuntu"
sudo apt install git wget unzip python curl python-dev build-essential -q -y
echo "Téléchargement de pip"
wget https://bootstrap.pypa.io/get-pip.py
echo "Téléchargement de Terraform"
wget https://releases.hashicorp.com/terraform/0.11.7/terraform_0.11.7_linux_amd64.zip -O terraform.zip
echo "Téléchargement de Terraform Docs"
wget https://github.com/segmentio/terraform-docs/releases/download/v0.3.0/terraform-docs_linux_amd64 -O terraform-docs
echo "Ajout de Terraform et Terraform-docs dans /home/${USER}/.local/bin/"
unzip terraform.zip
mv terraform /home/${USER}/.local/bin/
mv terraform-docs /home/${USER}/.local/bin/
echo "installation de pip en mode user"
python get-pip.py --user
echo "verification du path"
if [[ ":$PATH:" == *":$HOME/.local/bin"* ]]; then
echo "Your path is correctly set"
else
echo "Ajout de /home/${USER}/.local/bin dans le path"
PATH=$PATH:/home/${USER}/.local/bin
export PATH
fi
echo "Mise a jour de pip par pip"
pip install pip --upgrade --user
echo "installation des outils pour ansible"
pip install ansible-lint ansible-docgen pre-commit ansible[azure] pywinrm molecule --user

Configuration de Pre-Commit

Pre-commit permet d’exécuter des petits tests sur le code lors du commit dans un hooks “pre-commit”.

Dans le repo Git, ajoutez un fichier .pre-commit-config.yaml, c’est lui qui indiquera à pre-commit ce qu’il doit configurer dans git (.git/hooks) :

Wordpress ne conservant pas bien les espaces je vous invite a récupérer une version sur mon GitHub ici

cat >./.pre-commit-config.yaml
---
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v1.3.0
hooks:
- id: check-yaml
- id: check-xml
- id: check-json
- id: end-of-file-fixer
- id: check-case-conflict
- id: check-merge-conflict
#- id: check-executables-have-shebangs
- id: check-added-large-files
- id: trailing-whitespace
- id: detect-private-key
- id: pretty-format-json
- id: sort-simple-yaml
- repo: https://github.com/willthames/ansible-lint.git
rev: v3.5.0rc1
hooks:
- id: ansible-lint
files: \.(yaml|yml)$
exclude: ./env/
- repo: git://github.com/antonbabenko/pre-commit-terraform
rev: v1.7.3
hooks:
- id: terraform_fmt
- id: terraform_docs
EOF

Puis on l’ajoute à l’index :

git add .pre-commit-config.yaml

On commit :

git commit . -m "validation des pré commit hooks" -n
git push origin master

En suite, on valide l’installation des éléments voulu avec :

pre-commit install
pre-commit installed at /mnt/c/Users/etien/Documents/it/blog/.git/hooks/pre-commit

et on run sur les fichiers existent :

2018-06-23 10:03:04 ⌚ etienne in /mnt/c/Users/etien/Documents/it/blog
± | master S:7 U:1 ✗| → pre-commit run --all-files
Check Yaml...............................................................Passed
Check Xml............................................(no files to check)Skipped
Check JSON...........................................(no files to check)Skipped
Fix End of Files.........................................................Passed
Check for case conflicts.................................................Passed
Check for merge conflicts................................................Passed
Check for added large files..............................................Passed
Trim Trailing Whitespace.................................................Passed
Detect Private Key.......................................................Passed
Pretty format JSON...................................(no files to check)Skipped
Sort simple YAML files...............................(no files to check)Skipped
Ansible-lint.............................................................Passed
Terraform fmt............................................................Passed
Terraform docs...........................................................Passed

Test avec git

Ajoutez un fichier à l’index avec git add fichier.yml avec ce contenu :

---
- name: Check Installed Updates
win_updates:
category_names:
- SecurityUpdates
- CriticalUpdates
- UpdateRollups
state: searched
log_path: c:\ansible_wu1.txt
register: search_updates
tags:
- updates

J’ai volontairement ajouté des espaces qui ne sont peut-être pas visible avec Wordpress, dans ce cas utiliser un playbook ansible ici

Et tentez de faire un commit :

git commit .
Check Yaml...............................................................Passed
Check Xml............................................(no files to check)Skipped
Check JSON...........................................(no files to check)Skipped
Fix End of Files.........................................................Passed
Check for case conflicts.................................................Passed
Check for merge conflicts................................................Passed
Check for added large files..............................................Passed
Trim Trailing Whitespace.................................................Failed
hookid: trailing-whitespace

Files were modified by this hook. Additional output:

Fixing test.yml

Detect Private Key.......................................................Passed
Pretty format JSON...................................(no files to check)Skipped
Sort simple YAML files...............................(no files to check)Skipped
Ansible-lint.............................................................Passed
Terraform fmt........................................(no files to check)Skipped
Terraform docs.......................................(no files to check)Skipped

Le hook de pre-commit trim trailing whitespace a nettoyer les espaces en trop dans votre fichier. Il vous faudra donc ajouter à nouveau le fichier de test à l’index avec un git add test.yml, puis faite un nouveau commit :

git add test.yml
git commit . -m "Test"
Check Yaml...............................................................Passed
Check Xml............................................(no files to check)Skipped
Check JSON...........................................(no files to check)Skipped
Fix End of Files.........................................................Passed
Check for case conflicts.................................................Passed
Check for merge conflicts................................................Passed
Check for added large files..............................................Passed
Trim Trailing Whitespace.................................................Passed
Detect Private Key.......................................................Passed
Pretty format JSON...................................(no files to check)Skipped
Sort simple YAML files...............................(no files to check)Skipped
Ansible-lint.............................................................Passed
Terraform fmt........................................(no files to check)Skipped
Terraform docs.......................................(no files to check)Skipped
[master 8a6cf31] Adding test.yml
1 files changed, 10 insertions(+), 0 deletions(-)
create mode 100644 test.yml

Voila, maintenant vous savez comment installer des hooks de pre-commit pour faire une pré-validation.

Pour aller un peu plus loin, je vous invite à lire mon article sur la gestion automatique de la documentation avec Terraform-Docs et Ansible-Docgen.