Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mariochampion/liquibase-drift-reports
A quick python setup for automating diff reports (aka drift reports) using the new Liquibase Pro diff as json capability
https://github.com/mariochampion/liquibase-drift-reports
Last synced: 18 days ago
JSON representation
A quick python setup for automating diff reports (aka drift reports) using the new Liquibase Pro diff as json capability
- Host: GitHub
- URL: https://github.com/mariochampion/liquibase-drift-reports
- Owner: mariochampion
- License: apache-2.0
- Created: 2020-05-10T22:51:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-05-14T14:04:43.000Z (over 4 years ago)
- Last Synced: 2024-10-30T07:57:49.366Z (2 months ago)
- Language: Python
- Size: 26.4 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# liquibase-drift-reports
## A quick python setup for automating diff reports (aka drift reports) using the new Liquibase Pro diff as json capability
## Purpose & Goal
Liquibase Pro can help you automate drift detection at scale in your database schemas with a new structured and machine readable diff output as 1json1. This additional capability is an Pro extension to the existing community command "diff", and is invoked with a new --format option.
```bash
$> liquibase diff --format=json
```
This outputs a `JSON` structured object listing the differences between two databases (as configured in your `liquibase.properties` or Maven POM file under the `url` and `referenceUrl` keys.) By default, the result is output to `STDOUT`, which provides you with maximum flexibility to pipe the result into other tools or a processing pipeline. You can also have the output delivered to a file, using the `"-outputFile=` global parameter, as in
`$> liquibase --outputFile=myfile.json diff --format=json `
Whether you choose `STDOUT` or a collection of files, you can then process this data to generate reports, to trigger actions, from alerts to diffChangeLogs, to updates, or whatever make sense for how you use Liquibase.
## Getting Started
1. cd to your Liquibase project, which is typically the dir where you have your liquibase.properties file and
`git clone https://github.com/mariochampion/liquibase-drift-reports.git`
2. In my setup, I have kept some values in `liquibase.properties`, including `username`, `password`, `referenceUsername`, and `referencePassword`.
Your directories should look like this:
```
├── my_liquibase_project
| ├── sql
| | ├── liquibase.properties
| | ├── my_sql_changelog.mysql.sql
| | ├── drift_dblist.txt
| | ├── drift_reports_conf.py
| | ├── drift_reports.py
| | ├── drift_reports (a generated directory on first run)
| | | ├── (a generated directory on every run)
| | | | ├── drift-refdb-db01-to-db02.json
| | | | ├── drift-refdb-db01-to-db05.json
| | | | ├──
```
3. Configure `drift_reports_conf.py` for your usage by first removing the `.sample` from the file name. Pay most attention to where you store your
* reference database values
* list of target databases. In the sample this is 'drift_dblist.txt' but this file can be anywhere and generated in many ways. (An exercise left to the reader!)
4. Enjoy!
### Prerequisites
#### Software
* [Liquibase](http://liquibase.com/)
* A project using `Liquibase`
* [Python3](https://www.python.org/downloads/)
* Terminal/Command Line familiarity
#### Permissions
* Internet Access
* File and directory creation permissions
* Optional: Create aliases in ~/.bash_profile (or equivalent)
## Installing
```bash
git clone https://github.com/mariochampion/liquibase-drift-reports.git
```
Et voila, you are ready to explore!
## Usage:
```bash
python drift_reports.py
```
#### As a shortcut, add an alias in your .bash_profile to launch it via alias 'drift_reports' at the command line:
```bash
nano ~/.bash_profile
```
Then add this line to your bash_profile and save
```bash
alias drift_reports="cd path/to/install/dir/;python drift_report.py"
```
Then you can launch it with
```bash
$> drift_reports
```
## Contributing
I am very open to issues and pull requests. Looking for a place to start helping?
https://github.com/mariochampion/liquibase-drift-reports
## Authors
* **Mario Champion** - *Initial work* - [mariochampion](https://github.com/mariochampion)
Contributions, Issues, and Pull requests Welcome!
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Liquibase Community
* StackExchange
* Python
thanks and always remember: this robot loves you.
boop boop!