├── .gitignore ├── .travis.yml ├── LICENSE.txt ├── README.md ├── ansibleinventorygrapher ├── __init__.py ├── __main__.py ├── inventory.py └── version.py ├── pyproject.toml ├── setup.cfg ├── tests ├── __init__.py ├── inventory │ ├── group_vars │ │ ├── grandparent │ │ └── parent │ ├── host_vars │ │ └── host │ ├── hosts │ └── hosts.yml ├── prod-web-server-1a.dot ├── prod-web-server-1a.png ├── test_variables.py ├── test_vault.py ├── vault │ ├── group_vars │ │ ├── inline.yml │ │ └── web │ ├── inventory │ ├── notthevaultpass │ └── vaultpass └── vault_ids │ ├── host_vars │ └── web-01.yml │ ├── inventory │ └── vaultpass └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | dist 3 | *.egg-info 4 | .eggs 5 | .tox 6 | build 7 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # Based on https://github.com/pantsbuild/pex/blob/master/.travis.yml 2 | # 3 | # Enables support for a docker container-based build 4 | # which should provide faster startup times and beefier 5 | # "machines". 6 | # See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/ 7 | sudo: false 8 | dist: xenial 9 | 10 | # TRAVIS_PYTHON_VERSION 11 | 12 | matrix: 13 | include: 14 | - language: python 15 | python: "2.7" 16 | env: TOXENV=py27-flake8 17 | 18 | - language: python 19 | python: "2.7" 20 | env: TOXENV=py27-ansible24 21 | 22 | - language: python 23 | python: "2.7" 24 | env: TOXENV=py27-ansible25 25 | 26 | - language: python 27 | python: "2.7" 28 | env: TOXENV=py27-ansible26 29 | 30 | - language: python 31 | python: "2.7" 32 | env: TOXENV=py27-ansible27 33 | 34 | - language: python 35 | python: "2.7" 36 | env: TOXENV=py27-ansible28 37 | 38 | - language: python 39 | python: "2.7" 40 | env: TOXENV=py27-ansibledevel 41 | 42 | 43 | - language: python 44 | python: "3.7" 45 | env: TOXENV=py37-ansible24 46 | 47 | - language: python 48 | python: "3.7" 49 | env: TOXENV=py37-ansible25 50 | 51 | - language: python 52 | python: "3.7" 53 | env: TOXENV=py37-ansible26 54 | 55 | - language: python 56 | python: "3.7" 57 | env: TOXENV=py37-ansible27 58 | 59 | - language: python 60 | python: "3.7" 61 | env: TOXENV=py37-ansible28 62 | 63 | - language: python 64 | python: "3.7" 65 | env: TOXENV=py37-ansibledevel 66 | 67 | - language: python 68 | python: "3.7" 69 | env: TOXENV=py37-flake8 70 | 71 | install: 72 | - pip install -r test-deps.txt 73 | 74 | script: 75 | - tox -v 76 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Summary 2 | ansible-inventory-grapher creates a dot file suitable for use by 3 | graphviz 4 | 5 | Requires: 6 | * ansible 7 | * graphviz 8 | 9 | [![PyPI version](https://img.shields.io/pypi/v/ansible-inventory-grapher.svg)](https://pypi.python.org/pypi/ansible-inventory-grapher) 10 | [![Build Status](https://travis-ci.org/willthames/ansible-inventory-grapher.svg?branch=master)](https://travis-ci.org/willthames/ansible-inventory-grapher) 11 | 12 | ## Getting started 13 | ```bash 14 | pip install ansible-inventory-grapher 15 | ``` 16 | 17 | ## Usage 18 | ``` 19 | Usage: ansible-inventory-grapher [options] pattern1 [pattern2...] 20 | 21 | Options: 22 | --version show program's version number and exit 23 | -h, --help show this help message and exit 24 | -i INVENTORY specify inventory host file [/etc/ansible/hosts] 25 | -d DIRECTORY Location to output resulting files [current directory] 26 | -o FORMAT, --format=FORMAT 27 | python format string to name output files (e.g. 28 | {}.dot) [defaults to stdout] 29 | -q, --no-variables Turn off variable display in default template 30 | -t TEMPLATE path to jinja2 template used for creating output 31 | -T print default template 32 | -a ATTRIBUTES include top-level graphviz attributes from 33 | http://www.graphviz.org/doc/info/attrs.html 34 | [rankdir=TB;] 35 | --ask-vault-pass prompt for vault password 36 | --vault-password-file=VAULT_PASSWORD_FILE 37 | Location of file with cleartext vault password 38 | ``` 39 | 40 | Using the example inventory in https://github.com/willthames/ansible-ec2-example, 41 | we can generate the dot files for two of the example web servers using: 42 | ```bash 43 | bin/ansible-inventory-grapher -i ../ansible-ec2-example/inventory/hosts \ 44 | prod-web-server-78a prod-web-server-28a \ 45 | -d test --format "test-{hostname}.dot" 46 | ``` 47 | 48 | You can add the `-a` option to insert a string with graphviz attributes (http://www.graphviz.org/doc/info/attrs.html) to apply to the root level of the graph. Some fun examples: 49 | ```bash 50 | # transpose the tree so it grows from left-right instead of top-bottom 51 | -a "rankdir=LR;" 52 | 53 | # circular layout, with group nodes shaded grey 54 | -a "layout=circo; overlap=false; splines=polyline;\ 55 | node [ style=filled fillcolor=lightgrey ]" 56 | 57 | # orthogonal, UML-like inheritance connectors 58 | -a "rankdir=LR; splines=ortho; ranksep=2;\ 59 | node [ width=5 style=filled fillcolor=lightgrey ];\ 60 | edge [ dir=back arrowtail=empty ];" 61 | ``` 62 | 63 | You can replace the default template (which can be seen by passing the `-T` variable to `ansible-inventory-grapher`) with a template file that can be 64 | passed with the `-t` option. 65 | 66 | The resulting graphs can then be converted to pngs using: 67 | ```bash 68 | for f in test/*.dot ; do dot -Tpng -o test/`basename $f .dot`.png $f; done 69 | ``` 70 | 71 | ![Resulting image for prod-web-server-78a](tests/prod-web-server-1a.png) 72 | 73 | Or the whole thing can now be done in one pipeline (only works for one pattern) 74 | straight to image viewer (imagemagick's display in this example) 75 | ```bash 76 | bin/ansible-inventory-grapher -i ../ansible-ec2-example/inventory/hosts \ 77 | prod-web-server-1a | dot -Tpng | display png:- 78 | ``` 79 | 80 | This works with valid Ansible patterns now although only hosts and groups have been tested. 81 | -------------------------------------------------------------------------------- /ansibleinventorygrapher/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # (c) 2014, Will Thames 4 | # 5 | # ansible-inventory-grapher is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # ansible-inventory-grapher is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with ansible-inventory-grapher. If not, see . 17 | 18 | from ansible.parsing.yaml.objects import AnsibleVaultEncryptedUnicode 19 | 20 | # Cache for parent graph lookups 21 | _parents = dict() 22 | 23 | # Cache for variables 24 | _vars = None 25 | 26 | 27 | class Edge(object): 28 | def __init__(self, source, target): 29 | self.source = source 30 | self.target = target 31 | 32 | def __repr__(self): 33 | return "{} -> {}".format(self.source, self.target) 34 | 35 | def __eq__(self, other): 36 | return self.source == other.source and self.target == other.target 37 | 38 | def __hash__(self): 39 | return hash(self.source + self.target) 40 | 41 | 42 | class Node(object): 43 | def __init__(self, name, vars={}, leaf=False): 44 | self.name = name 45 | self.leaf = leaf 46 | self.vars = vars 47 | 48 | def __repr__(self): 49 | return self.name 50 | 51 | def __eq__(self, other): 52 | return self.name == other.name 53 | 54 | def __hash__(self): 55 | return hash(self.name) 56 | 57 | 58 | def parent_graphs(child, groups): 59 | results = _parents.get(child.name, list()) 60 | if not results: 61 | for group in groups: 62 | # For all other groups, if its parents contain this group, then 63 | # don't add this group as an edge 64 | if not any([group in g.parent_groups for g in groups if g != group]): 65 | results.append(Edge(group.name, child.name)) 66 | if group.parent_groups: 67 | results.extend(parent_graphs(group, group.parent_groups)) 68 | _parents[child.name] = results 69 | return results 70 | 71 | 72 | def remove_inherited_and_overridden_vars(vars, group, inventory_mgr): 73 | if group not in _vars: 74 | _vars[group] = inventory_mgr.inventory.get_group_vars(group) 75 | gv = _vars[group] 76 | for k, v in vars.copy().items(): 77 | if k in gv: 78 | if isinstance(v, AnsibleVaultEncryptedUnicode) and isinstance( 79 | gv[k], AnsibleVaultEncryptedUnicode 80 | ): 81 | comparison = (gv[k]._ciphertext, v._ciphertext) 82 | else: 83 | if isinstance(v, AnsibleVaultEncryptedUnicode) or isinstance( 84 | gv[k], AnsibleVaultEncryptedUnicode 85 | ): 86 | comparison = [0, 1] 87 | else: 88 | comparison = (gv[k], v) 89 | if comparison[0] == comparison[1]: 90 | del vars[k] 91 | else: 92 | del gv[k] 93 | 94 | 95 | def remove_inherited_and_overridden_group_vars(group, inventory_mgr): 96 | if group not in _vars: 97 | _vars[group] = inventory_mgr.inventory.get_group_vars(group) 98 | for ancestor in group.get_ancestors(): 99 | remove_inherited_and_overridden_vars(_vars[group], ancestor, inventory_mgr) 100 | 101 | 102 | def tidy_all_the_variables(host, inventory_mgr): 103 | """removes all overridden and inherited variables from hosts 104 | and groups""" 105 | global _vars 106 | _vars = dict() 107 | _vars[host] = inventory_mgr.inventory.get_host_vars(host) 108 | for group in host.get_groups(): 109 | remove_inherited_and_overridden_vars(_vars[host], group, inventory_mgr) 110 | remove_inherited_and_overridden_group_vars(group, inventory_mgr) 111 | return _vars 112 | 113 | 114 | def generate_graph_for_host(host, inventory_mgr): 115 | # dedup graph edges 116 | edges = set(parent_graphs(host, host.groups)) 117 | vars = tidy_all_the_variables(host, inventory_mgr) 118 | nodes = set() 119 | nodes.add(Node(host.name, vars=vars[host], leaf=True)) 120 | 121 | for group in host.get_groups(): 122 | nodes.add(Node(group.name, vars=vars[group])) 123 | 124 | return (edges, nodes) 125 | -------------------------------------------------------------------------------- /ansibleinventorygrapher/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # (c) 2014, Will Thames 4 | # 5 | # ansible-inventory-grapher is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # ansible-inventory-grapher is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with ansible-inventory-grapher. If not, see . 17 | 18 | from __future__ import print_function 19 | 20 | import jinja2 21 | import optparse 22 | import os 23 | import sys 24 | from ansible import constants 25 | 26 | import ansibleinventorygrapher.inventory 27 | from ansibleinventorygrapher.version import __version__ 28 | 29 | 30 | DEFAULT_TEMPLATE = """digraph {{pattern|labelescape}} { 31 | {{ attributes }} 32 | 33 | {% for node in nodes|sort(attribute='name') %} 34 | {% if node.leaf %} 35 | {{ node.name|labelescape }} [shape=record style=rounded label=< 36 | 37 | 40 | {% if node.vars and showvars %}
{% endif %} 43 |
38 | {{ node.name}} 39 |
{% for var in 41 | node.vars|sort %}{{var}}{% if var|is_visible %} = {{node.vars[var]}}{% endif %}
{% 42 | endfor %}
44 | >] 45 | {% else %} 46 | {{ node.name|labelescape }} [shape=record label=< 47 | 48 | 51 | {% if node.vars and showvars %}
{% endif %} 54 |
49 | {{ node.name}} 50 |
{% for 52 | var in node.vars|sort %}{{var}}{% if var|is_visible %} = {{node.vars[var]}}{% endif %}
{% 53 | endfor %}
55 | >] 56 | {% endif %}{% endfor %} 57 | 58 | {% for edge in edges|sort(attribute='source') %} 59 | {{ edge.source|labelescape }} -> {{ edge.target|labelescape }}; 60 | {% endfor %} 61 | } 62 | 63 | """ 64 | 65 | 66 | def options_parser(): 67 | usage = "%prog [options] pattern1 [pattern2 ...]" 68 | parser = optparse.OptionParser(usage=usage, version="%prog " + __version__) 69 | parser.add_option( 70 | "-i", 71 | dest="inventory", 72 | help="specify inventory host file [%default]", 73 | default=constants.DEFAULT_HOST_LIST, 74 | ) 75 | parser.add_option( 76 | "-d", 77 | dest="directory", 78 | help="Location to output resulting files [current directory]", 79 | default=os.getcwd(), 80 | ) 81 | parser.add_option( 82 | "-o", 83 | "--format", 84 | dest="format", 85 | default="-", 86 | help="python format string to name output files " 87 | + "(e.g. {}.dot) [defaults to stdout]", 88 | ) 89 | parser.add_option( 90 | "-q", 91 | "--no-variables", 92 | dest="showvars", 93 | action="store_false", 94 | default=True, 95 | help="Turn off variable display in default template", 96 | ) 97 | parser.add_option( 98 | "-t", dest="template", help="path to jinja2 template used for creating output" 99 | ) 100 | parser.add_option( 101 | "-T", dest="print_template", action="store_true", help="print default template" 102 | ) 103 | parser.add_option( 104 | "-a", 105 | dest="attributes", 106 | help="include top-level graphviz attributes from " 107 | + "http://www.graphviz.org/doc/info/attrs.html [%default]", 108 | default="rankdir=TB;", 109 | ) 110 | parser.add_option( 111 | "--ask-vault-pass", 112 | dest="ask_vault_pass", 113 | default=constants.DEFAULT_ASK_VAULT_PASS, 114 | action="store_true", 115 | help="prompt for vault password", 116 | ) 117 | parser.add_option( 118 | "--vault-password-file", 119 | dest="vault_password_files", 120 | help="vault password file", 121 | action="append", 122 | type="string", 123 | ) 124 | parser.add_option( 125 | "--vault-id", 126 | default=[], 127 | dest="vault_ids", 128 | action="append", 129 | type="string", 130 | help="the vault identity to use", 131 | ) 132 | parser.add_option( 133 | "--visible-vars", 134 | default=[], 135 | dest="visible_vars", 136 | action="append", 137 | type="string", 138 | help="Show value of a specific variable. Repeat for multiple variables", 139 | ) 140 | parser.add_option( 141 | "--show-all-values", 142 | default=[], 143 | dest="all_vars_visible", 144 | action="store_true", 145 | help="Show values of all variables", 146 | ) 147 | return parser 148 | 149 | 150 | def labelescape(name): 151 | return '"%s"' % name.replace("-", "_").replace(".", "_") 152 | 153 | 154 | def load_template(options): 155 | def is_visible(name): 156 | return options.all_vars_visible or name in options.visible_vars 157 | 158 | env = jinja2.Environment( 159 | trim_blocks=True, loader=jinja2.FileSystemLoader(os.getcwd()) 160 | ) 161 | env.filters["labelescape"] = labelescape 162 | env.filters["is_visible"] = is_visible 163 | 164 | if options.template: 165 | template = env.get_template(options.template) 166 | else: 167 | template = env.from_string(DEFAULT_TEMPLATE) 168 | return template 169 | 170 | 171 | def render_graph(pattern, options): 172 | try: 173 | inventory_mgr = ansibleinventorygrapher.inventory.InventoryManager( 174 | options.inventory, 175 | options.ask_vault_pass, 176 | options.vault_password_files, 177 | options.vault_ids, 178 | ) 179 | except ansibleinventorygrapher.inventory.NoVaultSecretFound: 180 | raise SystemExit("Couldn't find a secret to decrypt vaulted file(s)") 181 | 182 | hosts = inventory_mgr.inventory.list_hosts(pattern) 183 | template = load_template(options) 184 | if not hosts: 185 | print("No hosts matched for pattern %s" % pattern, file=sys.stderr) 186 | return 187 | if not os.path.exists(options.directory): 188 | os.makedirs(options.directory) 189 | edges = set() 190 | nodes = set() 191 | for host in hosts: 192 | try: 193 | (host_edges, host_nodes) = ansibleinventorygrapher.generate_graph_for_host( 194 | host, inventory_mgr 195 | ) 196 | except ansibleinventorygrapher.inventory.NoVaultSecretFound: 197 | raise SystemExit("Couldn't find a secret to decrypt vaulted file(s)") 198 | edges |= host_edges 199 | nodes |= host_nodes 200 | output = template.render( 201 | edges=edges, 202 | nodes=nodes, 203 | pattern=pattern, 204 | attributes=options.attributes, 205 | showvars=options.showvars, 206 | ) 207 | if options.format != "-": 208 | filename = options.format.format(pattern) 209 | fullpath = os.path.join(options.directory, filename) 210 | with open(fullpath, "w") as f: 211 | f.write(output) 212 | else: 213 | sys.stdout.write(output) 214 | 215 | 216 | def main(): 217 | parser = options_parser() 218 | (options, args) = parser.parse_args() 219 | if options.print_template: 220 | print(DEFAULT_TEMPLATE) 221 | if not args: 222 | parser.print_help() 223 | return 1 224 | for arg in args: 225 | render_graph(arg, options) 226 | return 0 227 | 228 | 229 | if __name__ == "__main__": 230 | sys.exit(main()) 231 | -------------------------------------------------------------------------------- /ansibleinventorygrapher/inventory.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # (c) 2014, Will Thames 4 | # 5 | # ansible-inventory-grapher is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # ansible-inventory-grapher is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with ansible-inventory-grapher. If not, see . 17 | 18 | from ansible import constants 19 | from ansible.parsing.dataloader import DataLoader 20 | from ansible.vars.manager import VariableManager 21 | import ansible.inventory.manager 22 | 23 | 24 | class NoVaultSecretFound(Exception): 25 | pass 26 | 27 | 28 | class AnsibleInventory(object): 29 | 30 | def __init__(self, inventory, ask_vault_pass, vault_password_files, vault_ids): 31 | from ansible.cli import CLI 32 | 33 | super(AnsibleInventory, self).__init__() 34 | loader = DataLoader() 35 | if vault_ids or vault_password_files or ask_vault_pass: 36 | CLI.setup_vault_secrets( 37 | loader, vault_ids, vault_password_files, ask_vault_pass 38 | ) 39 | self.inventory = ansible.inventory.manager.InventoryManager( 40 | loader=loader, sources=inventory 41 | ) 42 | self.variable_manager = VariableManager(loader=loader) 43 | self.variable_manager.set_inventory(self.inventory) 44 | 45 | # internal fuctions that actually do the work 46 | # adapted almost entirely from lib/ansible/vars/manager.py 47 | def _plugins_inventory(self, entities): 48 | import os 49 | from ansible.plugins.loader import vars_loader 50 | from ansible.utils.vars import combine_vars 51 | 52 | """ merges all entities by inventory source """ 53 | data = {} 54 | for inventory_dir in self.variable_manager._inventory._sources: 55 | if "," in inventory_dir: # skip host lists 56 | continue 57 | elif not os.path.isdir(inventory_dir): # always pass 'inventory directory' 58 | inventory_dir = os.path.dirname(inventory_dir) 59 | 60 | for plugin in vars_loader.all(): 61 | data = combine_vars( 62 | data, self._get_plugin_vars(plugin, inventory_dir, entities) 63 | ) 64 | return data 65 | 66 | def _get_plugin_vars(self, plugin, path, entities): 67 | from ansible.inventory.host import Host 68 | 69 | data = {} 70 | try: 71 | data = plugin.get_vars(self.variable_manager._loader, path, entities) 72 | except AttributeError: 73 | for entity in entities: 74 | if isinstance(entity, Host): 75 | data.update(plugin.get_host_vars(entity.name)) 76 | else: 77 | data.update(plugin.get_group_vars(entity.name)) 78 | return data 79 | 80 | def get_group_vars(self, group): 81 | return self._plugins_inventory([group]) 82 | 83 | def get_host_vars(self, host): 84 | try: 85 | all_vars = self.variable_manager.get_vars(host=host, include_hostvars=True) 86 | except ansible.errors.AnsibleParserError: 87 | raise NoVaultSecretFound 88 | # play, host, task, include_hostvars, include_delegate_to 89 | magic_vars = [ 90 | "ansible_playbook_python", 91 | "groups", 92 | "group_names", 93 | "inventory_dir", 94 | "inventory_file", 95 | "inventory_hostname", 96 | "inventory_hostname_short", 97 | "omit", 98 | "playbook_dir", 99 | "ansible_version", 100 | "ansible_facts", 101 | ] 102 | return {k: v for (k, v) in all_vars.items() if k not in magic_vars} 103 | 104 | def get_group(self, group_name): 105 | return self.inventory.groups.get(group_name) 106 | 107 | def get_host(self, host): 108 | return self.inventory.get_host(host) 109 | 110 | def list_hosts(self, pattern): 111 | return self.inventory.list_hosts(pattern) 112 | 113 | 114 | class InventoryManager(object): 115 | def __init__( 116 | self, inventory, ask_vault_pass=False, vault_password_files=None, vault_ids=None 117 | ): 118 | 119 | if not vault_password_files: 120 | vault_password_files = [] 121 | if constants.DEFAULT_VAULT_PASSWORD_FILE: 122 | vault_password_files.append(constants.DEFAULT_VAULT_PASSWORD_FILE) 123 | if not vault_ids: 124 | vault_ids = [] 125 | self.inventory = AnsibleInventory( 126 | inventory, ask_vault_pass, vault_password_files, vault_ids 127 | ) 128 | -------------------------------------------------------------------------------- /ansibleinventorygrapher/version.py: -------------------------------------------------------------------------------- 1 | __version__ = "2.6.0" 2 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | name = "ansible-inventory-grapher" 7 | authors = [ 8 | {name = "Will Thames", email = "will@thames.id.au"}, 9 | ] 10 | description = "Creates graphs representing ansible inventory" 11 | requires-python = ">=3.10" 12 | license = {text = "GPLv3"} 13 | dependencies = [ 14 | 'ansible-core >= 2.12' 15 | ] 16 | dynamic = ["version", "readme"] 17 | 18 | [project.urls] 19 | Homepage = "https://github.com/willthames/ansible-inventory-grapher" 20 | 21 | [project.scripts] 22 | ansible-inventory-grapher = "ansibleinventorygrapher.__main__:main" 23 | 24 | [tool.setuptools.dynamic] 25 | version = {attr = "ansibleinventorygrapher.version.__version__"} 26 | readme = {file = ["README.md"], content-type = "text/markdown"} 27 | 28 | [project.optional-dependencies] 29 | dev = [ 30 | "black", 31 | "build", 32 | "flake8", 33 | "pytest", 34 | "tox", 35 | ] 36 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 110 3 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/willthames/ansible-inventory-grapher/d25fb727b20a6a5222d924be4e1e9c378e64d1c1/tests/__init__.py -------------------------------------------------------------------------------- /tests/inventory/group_vars/grandparent: -------------------------------------------------------------------------------- 1 | gp_not_overridden: "gp" 2 | gp_overridden_in_parent: "gp" 3 | gp_overridden_in_child: "gp" 4 | -------------------------------------------------------------------------------- /tests/inventory/group_vars/parent: -------------------------------------------------------------------------------- 1 | gp_overridden_in_parent: "parent" 2 | parent_overridden_in_child: "parent" 3 | parent_not_overridden: "parent" 4 | -------------------------------------------------------------------------------- /tests/inventory/host_vars/host: -------------------------------------------------------------------------------- 1 | gp_overridden_in_child: "child" 2 | parent_overridden_in_child: "child" 3 | child_only: "child" 4 | -------------------------------------------------------------------------------- /tests/inventory/hosts: -------------------------------------------------------------------------------- 1 | [grandparent:children] 2 | parent 3 | 4 | [parent] 5 | host 6 | -------------------------------------------------------------------------------- /tests/inventory/hosts.yml: -------------------------------------------------------------------------------- 1 | all: 2 | hosts: 3 | mail.example.com: 4 | children: 5 | webservers: 6 | hosts: 7 | foo.example.com: 8 | bar.example.com: 9 | dbservers: 10 | hosts: 11 | one.example.com: 12 | two.example.com: 13 | three.example.com: 14 | -------------------------------------------------------------------------------- /tests/prod-web-server-1a.dot: -------------------------------------------------------------------------------- 1 | digraph prod_web_server_1a { 2 | rankdir=TB; 3 | 4 | all [shape=record label=< 5 | 6 | 9 |
7 | all 8 |
customerdb_dbname
image
region
sshkey
storedb_dbname
10 | >] 11 | prod_web_server_1a [shape=record style=rounded label=< 12 | 13 | 16 |
14 | prod-web-server-1a 15 |
17 | >] 18 | production [shape=record label=< 19 | 20 | 23 |
21 | production 22 |
customerdb_host
customerdb_port
databases
env
security_group
storedb_host
storedb_port
24 | >] 25 | production_az_a [shape=record label=< 26 | 27 | 30 |
28 | production-az-a 29 |
subnet
zone
31 | >] 32 | production_web [shape=record label=< 33 | 34 | 37 |
35 | production-web 36 |
instance_type
38 | >] 39 | production_web_a [shape=record label=< 40 | 41 | 44 |
42 | production-web-a 43 |
45 | >] 46 | web [shape=record label=< 47 | 48 | 51 |
49 | web 50 |
customerdb_user
databases
storedb_user
52 | >] 53 | 54 | all -> web; 55 | all -> production; 56 | production -> production_web; 57 | production -> production_az_a; 58 | production_az_a -> production_web_a; 59 | production_web -> production_web_a; 60 | production_web_a -> prod_web_server_1a; 61 | web -> production_web; 62 | } 63 | -------------------------------------------------------------------------------- /tests/prod-web-server-1a.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/willthames/ansible-inventory-grapher/d25fb727b20a6a5222d924be4e1e9c378e64d1c1/tests/prod-web-server-1a.png -------------------------------------------------------------------------------- /tests/test_variables.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pytest 3 | 4 | import ansibleinventorygrapher.inventory 5 | 6 | 7 | @pytest.fixture 8 | def inventory_mgr(): 9 | invfile = os.path.join("tests", "inventory", "hosts") 10 | inventory_mgr = ansibleinventorygrapher.inventory.InventoryManager(invfile) 11 | yield inventory_mgr 12 | 13 | 14 | @pytest.fixture 15 | def host(inventory_mgr): 16 | yield inventory_mgr.inventory.get_host("host") 17 | 18 | 19 | @pytest.fixture 20 | def variables(inventory_mgr, host): 21 | yield ansibleinventorygrapher.tidy_all_the_variables(host, inventory_mgr) 22 | 23 | 24 | def test_gp_group_vars(inventory_mgr, variables): 25 | gp = inventory_mgr.inventory.get_group("grandparent") 26 | gvars = variables[gp] 27 | assert set(gvars.keys()) == set(["gp_not_overridden"]) 28 | assert gvars["gp_not_overridden"] == "gp" 29 | 30 | 31 | def test_parent_group_vars(inventory_mgr, variables): 32 | parent = inventory_mgr.inventory.get_group("parent") 33 | pvars = variables[parent] 34 | assert set(pvars.keys()) == set( 35 | ["parent_not_overridden", "gp_overridden_in_parent"] 36 | ) 37 | assert pvars["parent_not_overridden"] == "parent" 38 | 39 | 40 | def test_host_vars(variables, host): 41 | hvars = variables[host].copy() 42 | assert hvars["gp_overridden_in_child"] == "child" 43 | assert hvars["parent_overridden_in_child"] == "child" 44 | assert hvars["child_only"] == "child" 45 | -------------------------------------------------------------------------------- /tests/test_vault.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pytest 3 | 4 | import ansibleinventorygrapher.inventory 5 | 6 | 7 | def test_vault_password_file(): 8 | invfile = os.path.join("tests", "vault", "inventory") 9 | vault_password_files = [os.path.join("tests", "vault", "vaultpass")] 10 | inventory_mgr = ansibleinventorygrapher.inventory.InventoryManager( 11 | invfile, False, vault_password_files 12 | ) 13 | hostname = "web-01" 14 | host = inventory_mgr.inventory.get_host(hostname) 15 | group = inventory_mgr.inventory.get_group("web") 16 | the_vars = ansibleinventorygrapher.tidy_all_the_variables(host, inventory_mgr) 17 | assert the_vars[group]["text"] == "hello" 18 | 19 | 20 | def test_vault_password_files(): 21 | invfile = os.path.join("tests", "vault", "inventory") 22 | vault_password_files = [ 23 | os.path.join("tests", "vault", "vaultpass"), 24 | os.path.join("tests", "vault", "notthevaultpass"), 25 | ] 26 | inventory_mgr = ansibleinventorygrapher.inventory.InventoryManager( 27 | invfile, False, vault_password_files 28 | ) 29 | hostname = "web-01" 30 | host = inventory_mgr.inventory.get_host(hostname) 31 | group = inventory_mgr.inventory.get_group("web") 32 | the_vars = ansibleinventorygrapher.tidy_all_the_variables(host, inventory_mgr) 33 | assert the_vars[group]["text"] == "hello" 34 | 35 | 36 | def test_vault_ids(): 37 | invfile = os.path.join("tests", "vault_ids", "inventory") 38 | vault_ids = ["another_vault@" + os.path.join("tests", "vault_ids", "vaultpass")] 39 | inventory_mgr = ansibleinventorygrapher.inventory.InventoryManager( 40 | invfile, False, [], vault_ids 41 | ) 42 | hostname = "web-01" 43 | host = inventory_mgr.inventory.get_host(hostname) 44 | the_vars = ansibleinventorygrapher.tidy_all_the_variables(host, inventory_mgr) 45 | assert the_vars[host]["hello"] == "world" 46 | 47 | 48 | def test_no_vault_pass(): 49 | invfile = os.path.join("tests", "vault", "inventory") 50 | with pytest.raises(ansibleinventorygrapher.inventory.NoVaultSecretFound): 51 | inventory_mgr = ansibleinventorygrapher.inventory.InventoryManager( 52 | invfile, False, [] 53 | ) 54 | hostname = "web-01" 55 | host = inventory_mgr.inventory.get_host(hostname) 56 | ansibleinventorygrapher.tidy_all_the_variables(host, inventory_mgr) 57 | 58 | 59 | def test_inline_vault_without_password(): 60 | invfile = os.path.join("tests", "vault", "inventory") 61 | inventory_mgr = ansibleinventorygrapher.inventory.InventoryManager( 62 | invfile, False, [] 63 | ) 64 | hostname = "inline-01" 65 | host = inventory_mgr.inventory.get_host(hostname) 66 | group = inventory_mgr.inventory.get_group("inline") 67 | the_vars = ansibleinventorygrapher.tidy_all_the_variables(host, inventory_mgr) 68 | assert "text" in the_vars[group] 69 | assert "text" not in the_vars[host] 70 | -------------------------------------------------------------------------------- /tests/vault/group_vars/inline.yml: -------------------------------------------------------------------------------- 1 | db: !vault | 2 | $ANSIBLE_VAULT;1.1;AES256 3 | 36316466303535313834386566666235333232323735303535353639373037306162306361383466 4 | 6234346530336531393332623230666436653036353035640a613761623439666433653563343863 5 | 66333865356337336364303730313038613766653238613034376265383034376139353134613832 6 | 3237333736396533620a626338383436383166363039316330623536613666613264646432316639 7 | 3632 8 | 9 | text: !vault | 10 | $ANSIBLE_VAULT;1.1;AES256 11 | 61653864613338616435316135353134386233643363303865666335656137643235653633363737 12 | 3831633064613466643333373131313461633733663034380a303665373934626132636261636233 13 | 33626235643038643838653863616162613838363435643632373835323430626661613237636264 14 | 3262383965343235350a386535353166353362323932636432326334393264303962363038316635 15 | 3961 16 | -------------------------------------------------------------------------------- /tests/vault/group_vars/web: -------------------------------------------------------------------------------- 1 | $ANSIBLE_VAULT;1.1;AES256 2 | 31386662623432383565613762646663346334623535633239353434656139613738326333633038 3 | 6663633332653562396138393831653630626436343266310a333965626632343132633832353365 4 | 34666634336131353437363130303932643533393266636430343438376661626665306533393130 5 | 3237353631666330310a656564393130316531316639653034386133393631336439343337633562 6 | 61626239326466316462653430636232643165373434306535633234366639366337 7 | -------------------------------------------------------------------------------- /tests/vault/inventory: -------------------------------------------------------------------------------- 1 | [web] 2 | web-01 3 | 4 | [inline] 5 | inline-01 6 | -------------------------------------------------------------------------------- /tests/vault/notthevaultpass: -------------------------------------------------------------------------------- 1 | thiswontwork 2 | -------------------------------------------------------------------------------- /tests/vault/vaultpass: -------------------------------------------------------------------------------- 1 | helloworld 2 | -------------------------------------------------------------------------------- /tests/vault_ids/host_vars/web-01.yml: -------------------------------------------------------------------------------- 1 | $ANSIBLE_VAULT;1.2;AES256;another_vault 2 | 36613837383733376239333532356338636431316331636435393739313535636236306163626432 3 | 6336306163656638646431343138396465383132633865330a363033396631643665306566623064 4 | 33363533333963363236343134376634323765303134343532363632313236613165363636316237 5 | 6165363562323966620a636265306330623038393834656466613534393533653139653965643435 6 | 6431 7 | -------------------------------------------------------------------------------- /tests/vault_ids/inventory: -------------------------------------------------------------------------------- 1 | [web] 2 | web-01 3 | -------------------------------------------------------------------------------- /tests/vault_ids/vaultpass: -------------------------------------------------------------------------------- 1 | helloworld 2 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | minversion = 4 3 | envlist = py{310,311,312}-ansible-core{213,214,215,216,217,218},flake8,black 4 | 5 | [testenv] 6 | deps = 7 | ansible-core212: ansible-core>=2.12.0,<2.13 8 | ansible-core213: ansible-core>=2.13.0,<2.14 9 | ansible-core214: ansible-core>=2.14.0,<2.15 10 | ansible-core215: ansible-core>=2.15.0,<2.16 11 | ansible-core216: ansible-core>=2.16.0,<2.17 12 | ansible-core217: ansible-core>=2.17.0,<2.18 13 | extras = 14 | dev 15 | commands = 16 | pytest 17 | 18 | [testenv:black] 19 | commands = 20 | black --check --diff . 21 | [testenv:flake8] 22 | commands = 23 | flake8 tests ansibleinventorygrapher 24 | --------------------------------------------------------------------------------