first commit

Author: Gustavo Muniz do Carmo

.gitignore

@@ -0,0 +1,6 @@
+.vagrant/
+.vscode/
+*.retry
+ubuntu-*-cloudimg-console.log
+env
+__pycache__

.travis.yml

@@ -0,0 +1,17 @@
+---
+language: python
+python: "3.6"
+
+addons:
+  apt:
+    packages:
+      - python-pip
+
+install:
+  - pip install -r requirements.txt
+
+script:
+  - molecule test -s docker
+
+notifications:
+  webhooks: https://galaxy.ansible.com/api/v1/notifications/

.yamllint

@@ -0,0 +1,15 @@
+---
+extends: default
+ignore: |
+  **/lib/
+rules:
+  braces:
+    max-spaces-inside: 1
+    level: error
+  brackets:
+    max-spaces-inside: 1
+    level: error
+  line-length: disable
+  # NOTE(retr0h): Templates no longer fail this lint rule.
+  #               Uncomment if running old Molecule templates.
+  # truthy: disable

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Esign Consulting Ltda.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,34 @@
+# Same configuration file with different content in different environments
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![GitHub release](https://img.shields.io/github/release/codeyourinfra/same_cfgfile_diff_content.svg)](https://github.com/codeyourinfra/same_cfgfile_diff_content/releases/latest) [![Build status](https://travis-ci.org/codeyourinfra/same_cfgfile_diff_content.svg?branch=master)](https://travis-ci.org/codeyourinfra/same_cfgfile_diff_content) [![Ansible Role](https://img.shields.io/ansible/role/42056.svg)](https://galaxy.ansible.com/codeyourinfra/same_cfgfile_diff_content) [![Ansible Role downloads](https://img.shields.io/ansible/role/d/42056.svg)](https://galaxy.ansible.com/codeyourinfra/same_cfgfile_diff_content)
+
+This solution is explained in detail in the Codeyourinfra project blog post [How to deal with the same configuration file with different content in different environments](http://codeyourinfra.today/how-to-deal-with-the-same-configuration-file-with-different-content-in-different-environments). Check it out!
+
+## Problem
+
+The dev team has to deploy the application in different QA environments. The application requires a properties file where either the database string connection and the database credentials are defined. In each environment they are different. This is just an example of the same configuration file with different content in different environments.
+
+## Solution
+
+Instead of having a version of the same configuration file for each environment, it's possible to keep just one, including all the values required in every environment ([conncfg.yml](conncfg.yml)). This variables are then used during the **same_cfgfile_diff_content** [Ansible role](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)'s execution, when the configuration file's content is set, specific to each environment.
+
+```yml
+---
+- hosts: qa
+  vars_files:
+    - conncfg.yml
+  roles:
+    - same_cfgfile_diff_content
+```
+
+## Test
+
+First of all, turn on the 3 VMs that represent the QA environments, executing the command `$ vagrant up`. After that, execute the command `$ ansible-playbook playbook.yml`. Finally, in order to check the configuration file's content of every environment, execute the command `$ ansible qa -m shell -a "cat /etc/conn.properties"`.
+
+### Automated tests
+
+You can also test the solution automaticaly, by executing `./test.sh` or using [Molecule](https://molecule.readthedocs.io). With the latter, you can perform the test not only locally (the default), but in [AWS](https://aws.amazon.com) as well. During the Codeyourinfra's *continuous integration* process in Travis CI, the solution is tested on [Amazon EC2](https://aws.amazon.com/ec2).
+
+In order to get your environment ready for using *Molecule*, prepare your [Python virtual environment](https://docs.python.org/3/tutorial/venv.html), executing `python3 -m venv env && source env/bin/activate && pip install -r requirements.txt`. After that, just run the command `molecule test`, to test the solution locally in a [VirtualBox](https://www.virtualbox.org) VM managed by [Vagrant](https://www.vagrantup.com).
+
+If you prefer performing the test in AWS, bear in mind you must have your credentials appropriately in **~/.aws/credentials**. You can [configure it through the AWS CLI tool](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). The test is performed in the AWS region *Europe - London (eu-west-2)*. Just run `molecule test -s aws` and check the running instances through your [AWS Console](https://eu-west-2.console.aws.amazon.com/ec2/v2).

Vagrantfile

@@ -0,0 +1,19 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+load '../common/timestamp-appender.rb'
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "ubuntu/bionic64"
+
+  (1..3).each do |i|
+    config.vm.define "qa#{i}" do |qa|
+      qa.vm.hostname = "qa#{i}"
+      qa.vm.network "private_network", ip: "192.168.33.#{i}0"
+    end
+  end
+
+  config.vm.provider "virtualbox" do |v|
+    v.linked_clone = true
+  end
+end

ansible.cfg

@@ -0,0 +1,9 @@
+[defaults]
+callback_whitelist = profile_tasks
+host_key_checking = False
+roles_path = ../
+inventory = inventory.yml
+localhost_warning = False
+
+[inventory]
+enable_plugins = yaml

conncfg.yml

@@ -0,0 +1,15 @@
+---
+cfgfile_path: /etc/conn.properties
+content:
+  qa1:
+    url: jdbc:mysql://db1/mydb
+    username: qa1user
+    password: qa1secret
+  qa2:
+    url: jdbc:mysql://db2/mydb
+    username: qa2user
+    password: qa2secret
+  qa3:
+    url: jdbc:mysql://db3/mydb
+    username: qa3user
+    password: qa3secret

defaults/main.yml

@@ -0,0 +1,12 @@
+---
+cfgfile_path: /etc/conf
+content:
+  qa1:
+    prop1: A
+    prop2: B
+  qa2:
+    prop1: C
+    prop2: D
+  qa3:
+    prop1: E
+    prop2: F

inventory.yml

@@ -0,0 +1,17 @@
+---
+all:
+  children:
+    qa:
+      hosts:
+        qa1:
+          ansible_host: 192.168.33.10
+          ansible_ssh_private_key_file: .vagrant/machines/qa1/virtualbox/private_key
+        qa2:
+          ansible_host: 192.168.33.20
+          ansible_ssh_private_key_file: .vagrant/machines/qa2/virtualbox/private_key
+        qa3:
+          ansible_host: 192.168.33.30
+          ansible_ssh_private_key_file: .vagrant/machines/qa3/virtualbox/private_key
+  vars:
+    ansible_user: vagrant
+    ansible_python_interpreter: python3