Package: shaper
ShaperTool for render configurations from few templates/sources.Getting StartedThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.InstallingInstall viapypi:pip install shaperUse casesAim of shaper - make configuration management easier with templating, DSL and CMDBs.Step 1 - Convert existing project configurations to DSLcd myproject
shaper readWe will getout.ymlfile with DSL of our project configurationout.ymlmy-backend:src:main:resources:application-dev1.properties:spring.cache.type:'redis'spring.redis.host:'dev1.111111.0001.use1.cache.amazonaws.com'spring.redis.port:'6379'spring.redis.ssl:'false'spring.redis.ttl.minutes:'30'spring.redis.database:'0'spring.redis.available:'true'app.init.enabled:'true'app.email.support_address:'support@my-domain.com'app.email.default_from:'no-replay@my-domain.com'app.lock.provider:'redis'application-qa1.properties:spring.cache.type:'redis'spring.redis.host:dev1.111111.0001.use1.cache.amazonaws.comspring.redis.port:'6379'spring.redis.ssl:'false'spring.redis.ttl.minutes:'30'spring.redis.database:'0'spring.redis.available:'true'app.init.enabled:'true'app.email.support_address:'support@my-domain.com'app.email.default_from:'no-replay@my-domain.com'app.lock.provider:'redis'application-prod1.properties:spring.cache.type:'redis'spring.redis.host:dev1.111111.0001.use1.cache.amazonaws.comspring.redis.port:'6379'spring.redis.ssl:'false'spring.redis.ttl.minutes:'30'spring.redis.database:'0'spring.redis.available:'true'app.init.enabled:'true'app.email.support_address:'support@my-domain.com'app.email.default_from:'no-replay@my-domain.com'app.lock.provider:'redis'application.properties:app.init.enabled:'true'Step 2 - Agregate common parameters with YAML anchor/aliasUsing YAML specification let's rewrite duplicating data with anchors/aliasesout_refactored.ymlmappings.yml:redis:-host:&redis_dev_host'dev.111111.0001.use1.cache.amazonaws.com'db:dev1:&redis_dev1_dbname0qa1:&redis_qa1_dbname1-host:&redis_prod_host'prod.0000000.0001.use1.cache.amazonaws.com'db:prod1:&redis_prod1_dbname0common_properties:&common_propertiesspring.cache.type:'redis'spring.redis.port:'6379'spring.redis.ssl:'false'spring.redis.ttl.minutes:'30'spring.redis.available:'true'app.init.enabled:'true'app.email.support_address:'support@my-domain.com'app.email.default_from:'no-replay@my-domain.com'app.lock.provider:'redis'my-backend:src:main:resources:application-dev1.properties:<<:*common_propertiesspring.redis.host:*redis_dev_hostspring.redis.database:*redis_dev1_dbnameapplication-qa1.properties:<<:*common_propertiesspring.redis.host:*redis_dev_hostspring.redis.database:*redis_qa1_dbnameapplication-prod1.properties:<<:*common_propertiesspring.redis.host:*redis_prod_hostspring.redis.database:*redis_prod1_dbnameapplication.properties:app.init.enabled:'true'This datastructure after loads equal to previus version, but look much more pretty without duplicates parameters.Step 3 - Write properties from CMDBshaper write out_refactored.ymlStep 4 - EnjoyCheck diff with existing configuration, fix if something wrong and embed into your CD pipeline.Running the testsWe are using tox to agregate all testing steps. Just run it in project repository. All merges runs tests intravis.toxContributingIf you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.How to make a clean pull requestLook for a project's contribution instructions. If there are any, follow them.Create a personal fork of the project on Github (howto).Clone the fork on your local machine. Your remote repo on Github is calledorigin.Add the original repository as a remote calledupstream.If you created your fork a while ago be sure to pull upstream changes into your local repository.Create a new branch to work on! Branch fromdevelopif it exists, else frommaster.Implement/fix your feature, comment your code.Follow the code style of the project, including indentation.If the project has tests run them!Write or adapt tests as needed.Add or change the documentation as needed.Squash your commits into a single commit with git'sinteractive rebase. Create a new branch if necessary.Push your branch to your fork on Github, the remoteorigin.From your fork open a pull request in the correct branch. Target the project'sdevelopbranch if there is one, else go formaster!If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.Once the pull request is approved and merged you can pull the changes fromupstreamto your local repo and delete
your extra branch(es).And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.VersioningWe useversioneerfor versioning. For the versions available, see thetags on this repository.AuthorsIvan Bogomazov-arno49See also the list ofcontributorswho participated in this project.LicenseThis project is licensed under the Apache 2.0 - see theLICENSEfile for details