confini

Parse and merge multiple ini files in python3
git clone git://git.defalsify.org/python-confini.git
Log | Files | Refs | README | LICENSE

commit 93baa255c67cc9c2c3bf591954919bb877b35277
parent d443a653f392a27d6be0c6edcc9b40550bf34a6a
Author: Louis Holbrook <accounts-gitlab@holbrook.no>
Date:   Tue,  2 Nov 2021 05:13:35 +0000

Multi source directories

Diffstat:
A.gitignore | 6++++++
MCHANGELOG | 12+++++++++++-
ALICENSE | 14++++++++++++++
DLICENSE.txt | 674-------------------------------------------------------------------------------
AMANIFEST.in | 1+
AWAIVER | 17+++++++++++++++++
AWARRANTY | 5+++++
Mconfini/config.py | 205++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------
Aconfini/crypt/pgp.py | 53+++++++++++++++++++++++++++++++++++++++++++++++++++++
Mconfini/runnable/dump.py | 41++++++++++++++++++++++++++++++++++++++---
Arun_tests.sh | 10++++++++++
Msetup.cfg | 2+-
Msetup.py | 5+++--
Atests/files/bar.ini | 5+++++
Atests/files/crypt/baz.asc | 14++++++++++++++
Atests/files/crypt/foo.ini | 4++++
Atests/files/default/foo.ini | 3+++
Atests/files/foo.ini | 3+++
Atests/files/multi/one/bar.ini | 2++
Atests/files/multi/one/foo.ini | 4++++
Atests/files/multi/three/foo.ini | 5+++++
Atests/files/multi/two/bar.ini | 2++
Atests/files/multi/two/foo.ini | 4++++
Atests/files/remove/foo.ini | 4++++
Atests/files/translate/foo.ini | 10++++++++++
Atests/test_basic.py | 118+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Atests/test_enc.py | 52++++++++++++++++++++++++++++++++++++++++++++++++++++
Atests/test_env.py | 88+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Atests/test_multi.py | 50++++++++++++++++++++++++++++++++++++++++++++++++++
Atests/test_translate.py | 49+++++++++++++++++++++++++++++++++++++++++++++++++
30 files changed, 728 insertions(+), 734 deletions(-)

diff --git a/.gitignore b/.gitignore @@ -0,0 +1,6 @@ +build/ +*.egg-info/ +dist/ +__pycache__ +*.pyc +gmon.out diff --git a/CHANGELOG b/CHANGELOG @@ -1,6 +1,16 @@ -0.3.5 +0.5.0 + - License change from GPL to WTFPL + - Add remove method +0.4.2 + - Enable multiple config base and override for the dump tool +0.4.1 + - Enable multiple config base directories when passing list as config_dir argument +0.4.0 + - Enable multiple config override directories +0.3.6 - Fix logging bug in 0.3.4 update - Add key exist guard in add method +0.3.5-unreleased 0.3.4 - Fix bug in 0.3.3 update 0.3.3 diff --git a/LICENSE b/LICENSE @@ -0,0 +1,14 @@ + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + + Copyright (C) 2004 Sam Hocevar <sam@hocevar.net> + + Everyone is permitted to copy and distribute verbatim or modified + copies of this license document, and changing it is allowed as long + as the name is changed. + + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. You just DO WHAT THE FUCK YOU WANT TO. + diff --git a/LICENSE.txt b/LICENSE.txt @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <https://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<https://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/MANIFEST.in b/MANIFEST.in @@ -0,0 +1 @@ +include LICENSE WAIVER WARRANTY diff --git a/WAIVER b/WAIVER @@ -0,0 +1,17 @@ +# Copyright waiver for the python package "leveldir" + +I dedicate any and all copyright interest in this software to the +public domain. I make this dedication for the benefit of the public at +large and to the detriment of my heirs and successors. I intend this +dedication to be an overt act of relinquishment in perpetuity of all +present and future rights to this software under copyright law. + +To the best of my knowledge and belief, my contributions are either +originally authored by me or are derived from prior works which I have +verified are also in the public domain and are not subject to claims +of copyright by other parties. + +To the best of my knowledge and belief, no individual, business, +organization, government, or other entity has any copyright interest +in my contributions, and I affirm that I will not make contributions +that are otherwise encumbered. diff --git a/WARRANTY b/WARRANTY @@ -0,0 +1,5 @@ +This program is free software. It comes without any warranty, to + * the extent permitted by applicable law. You can redistribute it + * and/or modify it under the terms of the Do What The Fuck You Want + * To Public License, Version 2, as published by Sam Hocevar. See + * http://www.wtfpl.net/ for more details. diff --git a/confini/config.py b/confini/config.py @@ -1,23 +1,18 @@ +# standard imports import logging import sys import os import tempfile import configparser import re -import gnupg -from .error import DecryptError +# external imports +import gnupg logg = logging.getLogger('confini') current_config = None -gpg = gnupg.GPG( - verbose=False, - use_agent=True, - ) -gpg.encoding = 'utf-8' - def set_current(conf, description=''): global current_config @@ -30,26 +25,64 @@ class Config: parser = configparser.ConfigParser(strict=True) default_censor_string = '***' - def __init__(self, config_dir, env_prefix=None, decrypt=True): - if not os.path.isdir(config_dir): - raise OSError('{} is not a directory'.format(config_dir)) - self.dir = os.path.realpath(config_dir) + def __init__(self, default_dir, env_prefix=None, override_dirs=[]): + self.__target_tmpdir = None + if default_dir == None: + default_dir = override_dirs + if isinstance(default_dir, list): + self.collect_from_dirs(default_dir) + else: + self.dirs = [default_dir] + if isinstance(override_dirs, str): + override_dirs = [override_dirs] + elif override_dirs == None: + override_dirs = [] + for d in override_dirs: + if not os.path.isdir(d): + raise OSError('{} is not a directory'.format(override_dirs)) + self.dirs.append(os.path.realpath(d)) self.required = {} self.censored = {} self.store = {} - self.decrypt = decrypt + self.decrypt = [] self.env_prefix = None + self.src_dirs = {} if env_prefix != None: logg.info('using prefix {} for environment variable override matches'.format(env_prefix)) self.env_prefix = '{}_'.format(env_prefix) + def collect_from_dirs(self, dirs): + self.__target_tmpdir = tempfile.TemporaryDirectory() + self.dirs = [self.__target_tmpdir.name] + for i, d in enumerate(dirs): + for filename_in in os.listdir(d): + if re.match(r'.+\.ini$', filename_in) == None: + continue + filename_out = '{}_{}'.format(i, filename_in) + in_filepath = os.path.join(d, filename_in) + out_filepath = os.path.join(self.dirs[0], filename_out) + fr = open(in_filepath, 'rb') + fw = open(out_filepath, 'wb') + fw.write(fr.read()) + fw.close() + fr.close() + logg.debug('base config {} will be processed as {}'.format(in_filepath, out_filepath)) +# return target_dir.name + + + def add_decrypt(self, decrypter): + self.decrypt.append(decrypter) + + def add(self, value, constant_name, exists_ok=False): - if self.store.get(constant_name) != None: + value_stored = self.store.get(constant_name) + if not self.is_as_none(value_stored): if not exists_ok: raise AttributeError('config key {} already exists'.format(constant_name)) else: - logg.debug('overwriting key {}'.format(constant_name)) + if value_stored != value: + logg.debug('updating key {}'.format(constant_name)) self.store[constant_name] = value @@ -110,49 +143,87 @@ class Config: self.add(val, cn, exists_ok=True) + def set_dir(self, k, d): + logg.debug('set dir {} for key {}'.format(d, k)) + self.src_dirs[k] = d + + def process(self, set_as_current=False): """Concatenates all .ini files in the config directory attribute and parses them to memory """ - tmp = tempfile.NamedTemporaryFile(delete=False) - tmpname = tmp.name - for filename in os.listdir(self.dir): - if re.match(r'.+\.ini$', filename) == None: - logg.debug('skipping file {}'.format(filename)) - continue - logg.info('reading file {}'.format(filename)) - f = open(os.path.join(self.dir, filename), 'rb') - while 1: - data = f.read() - if not data: - break - tmp.write(data) - f.close() - tmp.close() - self.parser.read(tmpname) - os.unlink(tmpname) + tmp_dir = tempfile.mkdtemp() + logg.debug('using tmp processing dir {}'.format(tmp_dir)) + for i, d in enumerate(self.dirs): + d = os.path.realpath(d) + if i == 0: + d_label = 'default' + else: + d_label = 'override #' + str(i) + tmp_out_dir = os.path.join(tmp_dir, str(i)) + os.makedirs(tmp_out_dir) + logg.debug('processing dir {} ({})'.format(d, d_label)) + tmp_out = open(os.path.join(tmp_out_dir, 'config.ini'), 'ab') + for filename in os.listdir(d): + if re.match(r'.+\.ini$', filename) == None: + logg.debug('skipping file {}/{}'.format(d, filename)) + continue + logg.info('reading file {}/{}'.format(d, filename)) + f = open(os.path.join(d, filename), 'rb') + while 1: + data = f.read() + if not data: + break + tmp_out.write(data) + f.close() + tmp_out.close() + d = os.listdir(tmp_dir) + d.sort() + c = 0 + + # TODO: this will fail of sections/options are repeated. should first use individual parser instances to flatten to single file (perhaps in collect_from_dirs already) + for i, tmp_config_dir in enumerate(d): + tmp_config_dir = os.path.join(tmp_dir, tmp_config_dir) + for tmp_file in os.listdir(os.path.join(tmp_config_dir)): + tmp_config_file_path = os.path.join(tmp_config_dir, tmp_file) + if c == 0: + logg.debug('apply default parser for config directory {}'.format(self.dirs[i])) + self.parser.read(tmp_config_file_path) + for s in self.parser.sections(): + for so in self.parser.options(s): + k = self.to_constant_name(so, s) + v = self.parser.get(s, so) + logg.debug('default config set {}'.format(k)) + self.add(v, k, exists_ok=True) + self.set_dir(k, self.dirs[i]) + else: + logg.debug('apply override parser for config directory {}'.format(self.dirs[i])) + local_parser = configparser.ConfigParser(strict=True) + local_parser.read(tmp_config_file_path) + for s in local_parser.sections(): + for so in local_parser.options(s): + k = self.to_constant_name(so, s) + if not self.have(k): + raise KeyError('config overrides in {} defines key {} not present in default config {}'.format(self.dirs[i], k, self.dirs[0])) + v = local_parser.get(s, so) + logg.debug('checking {} {} {}'.format(k, s, so)) + if not self.is_as_none(v): + logg.debug('multi config file overrides {}'.format(k)) + self.add(v, k, exists_ok=True) + self.set_dir(k, self.dirs[i]) + c += 1 self._sections_override(os.environ, 'environment variable') if set_as_current: set_current(self, description=self.dir) - - def _decrypt(self, k, v): - if type(v).__name__ != 'str': - logg.debug('entry {} is not type str'.format(k)) + def _decrypt(self, k, v, src_dir): + if len(self.decrypt) == 0: return v - if self.decrypt: - m = re.match(r'^\!gpg\((.*)\)', v) - if m != None: - filename = m.group(1) - if filename[0] != '/': - filename = os.path.join(self.dir, filename) - f = open(filename, 'rb') - logg.debug('decrypting entry {} in file {}'.format(k, f)) - d = gpg.decrypt_file(f) - if not d.ok: - raise DecryptError() - v = str(d) - f.close() + for decrypter in self.decrypt: + logg.debug('applying decrypt with {}'.format(str(decrypter))) + (v, r) = decrypter.decrypt(k, v, src_dir) + if r: + return v return v @@ -162,14 +233,37 @@ class Config: if default != None: logg.debug('returning default value for empty value {}'.format(k)) return default - if type(v).__name__ == 'str' and v == '': + if self.is_as_none(v): if default != None: logg.debug('returning default value for empty string value {}'.format(k)) return default else: return None - return self._decrypt(k, v) + return self._decrypt(k, v, self.src_dirs.get(k)) + + + def remove(self, k, strict=True): + removes = [] + if strict: + removes = [k] + else: + l = len(k) + re_s = r'^' + k + for v in self.all(): + if len(v) >= l and re.match(re_s, v): + removes.append(v) + for v in removes: + del self.store[v] + logg.debug('removing key: {}'.format(v)) + + + def have(self, k): + try: + v = self.store[k] + return True + except KeyError: + return False def all(self): @@ -181,7 +275,7 @@ class Config: if type(v).__name__ == 'bool': logg.debug('entry {} is already bool'.format(k)) return v - d = self._decrypt(k, v) + d = self._decrypt(k, v, self.src_dirs.get(k)) if d.lower() not in ['true', 'false', '0', '1', 'on', 'off']: raise ValueError('{} not a boolean value'.format(k)) return d.lower() in ['true', '1', 'on'] @@ -195,7 +289,6 @@ class Config: return self.store[k] - def __str__(self): ls = [] for k in self.store.keys(): @@ -209,6 +302,12 @@ class Config: return "<Config '{}'>".format(self.dir) + @classmethod + def is_as_none(cls, v): + if isinstance(v, str) and v == '': + return True + if v == None: + return True def config_from_environment(): diff --git a/confini/crypt/pgp.py b/confini/crypt/pgp.py @@ -0,0 +1,53 @@ +# standard imports +import logging +import re +import os + +# external imports +import gnupg + +# local imports +from confini.error import DecryptError + + +logg = logging.getLogger(__name__) + +gpg = gnupg.GPG( + verbose=False, + use_agent=True, + ) +gpg.encoding = 'utf-8' + + + +class PGPDecrypter: + + def __init__(self, base_dir='.'): + self.base_dir = base_dir + + + def decrypt(self, k, v, src_dir=None): + if src_dir == None: + src_dir = self.base_dir + + if type(v).__name__ != 'str': + logg.debug('entry {} is not type str'.format(k)) + return (v, False) + + m = re.match(r'^\!gpg\((.*)\)', v) + if m != None: + filename = m.group(1) + if filename[0] != '/': + filename = os.path.join(src_dir, filename) + f = open(filename, 'rb') + logg.debug('decrypting entry {} in file {}'.format(k, f)) + d = gpg.decrypt_file(f) + if not d.ok: + raise DecryptError() + v = str(d) + f.close() + + return (v, m != None) + + def __str__(self): + return 'gpg decrypter' diff --git a/confini/runnable/dump.py b/confini/runnable/dump.py @@ -2,6 +2,9 @@ import sys import logging import argparse +import copy +import os +import stat # local imports from confini import Config @@ -13,21 +16,53 @@ logg = logging.getLogger() argparser = argparse.ArgumentParser() argparser.add_argument('-z', action='store_true', help='Truncate values in output') argparser.add_argument('-v', action='store_true', help='Be verbose') -argparser.add_argument('config_dir', type=str, help='Configuation directory to parse') +argparser.add_argument('--prefix', type=str, help='Prefix every line with given string') +argparser.add_argument('--skip-empty', action='store_true', dest='skip_empty', help='Skip defined directives that are missing a value') +argparser.add_argument('--schema-dir', dest='schema_dir', action='append', type=str, help='Configuation directory to merge with schema definitions') +argparser.add_argument('--schema-module', dest='schema_module', action='append', type=str, default=[], help='Module path to merge with schema definitions') +argparser.add_argument('config_dir', nargs='*', type=str, help='Configuation directories to parse') args = argparser.parse_args() if args.v: logg.setLevel(logging.DEBUG) +if args.z and args.skip_empty: + logg.warning('Both -z and --skip-empty are defined, this will produce no output') def main(): - c = Config(args.config_dir) + schema_dirs = [] + for m in args.schema_module: + md = m.replace('.', '/') + for i in range(len(sys.path)-1, -1, -1): + schema_mod_candidate = os.path.join(sys.path[i], md) + logg.debug('Probing config directory for module {} in {}'.format(m, schema_mod_candidate)) + try: + s = os.stat(schema_mod_candidate) + if not stat.S_ISDIR(s.st_mode): + continue + logg.info('Using config directory for module {} in {}'.format(m, schema_mod_candidate)) + except FileNotFoundError: + continue + schema_dirs.append(schema_mod_candidate) + + if args.schema_dir != None: + schema_dirs += args.schema_dir + + if len(schema_dirs) == 0: + schema_dirs = None + + c = Config(schema_dirs, override_dirs=args.config_dir) c.process() for k in c.store.keys(): v = c.get(k) if args.z or v == None: v = '' - print('{}={}'.format(k, v)) + if v == '' and args.skip_empty: + logg.debug('skipping empty directive {}'.format(k)) + continue + if args.prefix != None: + sys.stdout.write(args.prefix + ' ') + sys.stdout.write('{}={}\n'.format(k, v)) if __name__ == "__main__": diff --git a/run_tests.sh b/run_tests.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +set -e +set -x +export PYTHONPATH=$PYTHONPATH:. +for f in `ls tests/*.py`; do + python $f +done +set +x +set +e diff --git a/setup.cfg b/setup.cfg @@ -8,7 +8,7 @@ classifiers = Topic :: Software Development :: Libraries License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) license_files = - LICENSE.txt + LICENSE [options.entry_points] console_scripts = diff --git a/setup.py b/setup.py @@ -6,11 +6,11 @@ f.close() setup( name='confini', - version='0.3.6', + version='0.5.0rc1', description='Parse, verify and merge all ini files in a single directory', author='Louis Holbrook', author_email='dev@holbrook.no', - license='GPL3', + license='WTFPL', long_description=long_description, long_description_content_type='text/markdown', install_requires=[ @@ -19,6 +19,7 @@ setup( packages=[ 'confini', 'confini.runnable', + 'confini.crypt', ], url='https://gitlab.com/nolash/python-confini', ) diff --git a/tests/files/bar.ini b/tests/files/bar.ini @@ -0,0 +1,5 @@ +[BAR] +foo = oof + +[XYZZY] +bert = ernie diff --git a/tests/files/crypt/baz.asc b/tests/files/crypt/baz.asc @@ -0,0 +1,14 @@ +-----BEGIN PGP MESSAGE----- + +hQGMA8Ll7MXhlLGLAQv/Skj9eYN9MuR2JLIFJ7V2BYgpdakukamW6dCEwr1dyWbq +Uj0UurqSCJBg3qvDQvK2K/UU1ez2+Sot8i/rQY5Q7t9Daxlzp4PombtYw0R3dxLE +bcNCEv7tIr1VjW8cRvkgKc9CamcI2zcUDt2DGq+c9w8Hxn+N7KRF1ZZLGvb7nnTU +ugMyrQb8ILJDyw7ifjgjQFSeh5Kfg+tQAKaPTk7ydCqCXaODd1dCNE1IK/ebl8kT +gGm0db20lcNG9MOmmumD22hTovlouv1WcybpQGzNsogkiJxMRgCQ2DRRAxWOLyam +71iEcCb3w/xf+YISUSWkD+H1W0+2i0X6RTIVNYs/tEnI9/DypKV4wPWcsWbLsVqO +u8wodH5Kk3f/gwVd90wjmpYMrRCIL0/GOfMn8IglN58lOMEtopRtll/CbM8XcRUc +5vsCIcrBiZiwq6bfQxyPSVmpOsxz24BMvU537bVf5qI7KpFn5L5Gjo/Sy1Xq4rpT +avEBM1lXrRbEqXz/fd2J0j4BInKLK3yaAkBq0pFYvCFsHOB/7n0SUkOZcFBXxGGb +sDj+VuQr5hdhJbgyl0ZhsUvHaJQzKFn2N4cW8RQwmw== +=qkyQ +-----END PGP MESSAGE----- diff --git a/tests/files/crypt/foo.ini b/tests/files/crypt/foo.ini @@ -0,0 +1,4 @@ +[FOO] +bar = 42 +baz = !gpg(baz.asc) +xyzzy = diff --git a/tests/files/default/foo.ini b/tests/files/default/foo.ini @@ -0,0 +1,3 @@ +[FOO] +bar = xyzzy +baz = diff --git a/tests/files/foo.ini b/tests/files/foo.ini @@ -0,0 +1,3 @@ +[FOO] +bar = 42 +baz = 029a diff --git a/tests/files/multi/one/bar.ini b/tests/files/multi/one/bar.ini @@ -0,0 +1,2 @@ +[bar] +one = two diff --git a/tests/files/multi/one/foo.ini b/tests/files/multi/one/foo.ini @@ -0,0 +1,4 @@ +[FOO] +bar = xyzzy +baz = +bah = diff --git a/tests/files/multi/three/foo.ini b/tests/files/multi/three/foo.ini @@ -0,0 +1,5 @@ +[FOO] +bar = plugh +baz = 42 +bah = +mah = nah diff --git a/tests/files/multi/two/bar.ini b/tests/files/multi/two/bar.ini @@ -0,0 +1,2 @@ +[bar] +one = three diff --git a/tests/files/multi/two/foo.ini b/tests/files/multi/two/foo.ini @@ -0,0 +1,4 @@ +[FOO] +bar = plugh +baz = 42 +bah = diff --git a/tests/files/remove/foo.ini b/tests/files/remove/foo.ini @@ -0,0 +1,4 @@ +[foo] +bar = 1 +baz = 2 +xyzzy = 4 diff --git a/tests/files/translate/foo.ini b/tests/files/translate/foo.ini @@ -0,0 +1,10 @@ +[true] +a = true +b = True +c = 1 + +[false] +a = false +b = False +c = 0 +d = diff --git a/tests/test_basic.py b/tests/test_basic.py @@ -0,0 +1,118 @@ +#!/usr/bin/python + +import os +import unittest +import logging + +from confini import Config + +logging.basicConfig(level=logging.DEBUG) +logg = logging.getLogger() + +class TestBasic(unittest.TestCase): + + wd = os.path.dirname(__file__) + + def setUp(self): + pass + + + def tearDown(self): + pass + + + def test_parse_default(self): + inidir = os.path.join(self.wd, 'files/default') + c = Config(inidir) + c.process() + r = c.get('FOO_BAR', 'plugh') + self.assertEqual(r, 'xyzzy') + r = c.get('FOO_BAZ', 'plugh') + self.assertEqual(r, 'plugh') + r = c.get('FOO_BAZ') + self.assertEqual(r, None) + with self.assertRaises(KeyError): + r = c.get('FOO_BAZBAZ') + + + def test_parse_two(self): + inidir = os.path.join(self.wd, 'files/default') + c = Config(inidir, override_dirs=[inidir]) + c.process() + r = c.get('FOO_BAR', 'plugh') + self.assertEqual(r, 'xyzzy') + r = c.get('FOO_BAZ', 'plugh') + self.assertEqual(r, 'plugh') + r = c.get('FOO_BAZ') + self.assertEqual(r, None) + with self.assertRaises(KeyError): + r = c.get('FOO_BAZBAZ') + + + def test_overwrite_guard(self): + inidir = os.path.join(self.wd, 'files/default') + c = Config(inidir) + c.process() + with self.assertRaises(AttributeError): + c.add('xxx', 'FOO_BAR') + c.add('xxx', 'FOO_BAR', exists_ok=True) + r = c.get('FOO_BAR') + self.assertEqual(r, 'xxx') + + + def test_parse_two_files(self): + inidir = os.path.join(self.wd, 'files') + c = Config(inidir) + c.process() + c.require('BERT', 'XYZZY') + expect = { + 'FOO_BAR': '42', + 'FOO_BAZ': '029a', + 'BAR_FOO': 'oof', + 'XYZZY_BERT': 'ernie', + } + self.assertDictEqual(expect, c.store) + + + def test_require(self): + inidir = os.path.join(self.wd, 'files') + c = Config(inidir) + c.require('BERT', 'XYZZY') + self.assertTrue(c.validate()) + c.require('ERNIE', 'XYZZY') + self.assertFalse(c.validate()) + logg.debug(c) + + + def test_remove_strict(self): + inidir = os.path.join(self.wd, 'files/default') + c = Config(inidir) + c.process() + c.remove('FOO_BAR') + with self.assertRaises(KeyError): + c.get('FOO_BAR') + + + def test_remove_wild(self): + inidir = os.path.join(self.wd, 'files/remove') + c = Config(inidir) + c.process() + c.remove('FOO', strict=False) + self.assertEqual(len(c.all()), 0) + + c = Config(inidir) + c.process() + c.remove('FOO_BA', strict=False) + c.get('FOO_XYZZY') + self.assertEqual(len(c.all()), 1) + + + def test_all(self): + inidir = os.path.join(self.wd, 'files') + c = Config(inidir) + a = c.all() + self.assertEqual(a, list(c.store.keys())) + + +if __name__ == '__main__': + unittest.main() diff --git a/tests/test_enc.py b/tests/test_enc.py @@ -0,0 +1,52 @@ +#!/usr/bin/python + +import os +import unittest +import logging + +from confini import Config +from confini.error import DecryptError +from confini.crypt.pgp import PGPDecrypter + +logging.basicConfig(level=logging.DEBUG) +logg = logging.getLogger() + +script_dir = os.path.dirname(os.path.realpath(__file__)) +gnupg_dir = os.path.join(script_dir, 'gnupg') + +class TestBasic(unittest.TestCase): + + wd = os.path.dirname(__file__) + + def setUp(self): + pass + + def tearDown(self): + pass + + def test_enc(self): + inidir = os.path.join(self.wd, 'files/crypt') + c = Config(inidir) + decrypter = PGPDecrypter() + c.add_decrypt(decrypter) + c.process() + with self.assertRaises(DecryptError): + c.get('FOO_BAZ') + os.environ['GNUPGHOME'] = gnupg_dir + c.get('FOO_BAZ') + + + def test_decrypt_with_non_string(self): + inidir = os.path.join(self.wd, 'files/crypt') + c = Config(inidir) + decrypter = PGPDecrypter() + c.add_decrypt(decrypter) + c.process() + override = { + 'FOO_XYZZY': False, + } + c.dict_override(override, 'test') + c.get('FOO_XYZZY') + +if __name__ == '__main__': + unittest.main() diff --git a/tests/test_env.py b/tests/test_env.py @@ -0,0 +1,88 @@ +#!/usr/bin/python + +import os +import unittest +import logging + +from confini import Config + +logging.basicConfig(level=logging.DEBUG) +logg = logging.getLogger() + +class TestEnv(unittest.TestCase): + + wd = os.path.dirname(__file__) + + def setUp(self): + pass + + def tearDown(self): + pass + + def test_dict_override(self): + inidir = os.path.join(self.wd, 'files') + c = Config(inidir) + c.process() + + override_dict = { + 'FOO_BAR': '666', + 'XYZZY_BERT': 'oscar', + 'BAR_FOO': None, + } + c.dict_override(override_dict, 'arbitrary dict') + + expect = { + 'FOO_BAR': '666', + 'FOO_BAZ': '029a', + 'BAR_FOO': 'oof', + 'XYZZY_BERT': 'oscar', + } + self.assertDictEqual(expect, c.store) + + override_dict = { + 'BAR_FOO': 'barbarbar', + } + c.dict_override(override_dict, 'arbitrary dict') + + expect = { + 'FOO_BAR': '666', + 'FOO_BAZ': '029a', + 'BAR_FOO': 'barbarbar', + 'XYZZY_BERT': 'oscar', + } + self.assertDictEqual(expect, c.store) + + + + def test_env_a_override(self): + os.environ['FOO_BAR'] = '43' + inidir = os.path.join(self.wd, 'files') + c = Config(inidir) + c.process() + + os.environ['ZZZ_FOO_BAR'] = '44' + inidir = os.path.join(self.wd, 'files') + c = Config(inidir, env_prefix='ZZZ') + c.process() + expect = { + 'FOO_BAR': '44', + 'FOO_BAZ': '029a', + 'BAR_FOO': 'oof', + 'XYZZY_BERT': 'ernie', + } + self.assertDictEqual(expect, c.store) + + os.environ['ZZZ_FOO_BAR'] = '' + inidir = os.path.join(self.wd, 'files') + c = Config(inidir, env_prefix='ZZZ') + c.process() + expect = { + 'FOO_BAR': '42', + 'FOO_BAZ': '029a', + 'BAR_FOO': 'oof', + 'XYZZY_BERT': 'ernie', + } + self.assertDictEqual(expect, c.store) + +if __name__ == '__main__': + unittest.main() diff --git a/tests/test_multi.py b/tests/test_multi.py @@ -0,0 +1,50 @@ +#!/usr/bin/python + +import os +import unittest +import logging + +from confini import Config + +logging.basicConfig(level=logging.DEBUG) +logg = logging.getLogger() + + +class TestBasic(unittest.TestCase): + + wd = os.path.dirname(__file__) + + def setUp(self): + pass + + + def tearDown(self): + pass + + + def test_parse_two(self): + inidir_one = os.path.join(self.wd, 'files', 'multi', 'one') + inidir_two = os.path.join(self.wd, 'files', 'multi', 'two') + c = Config(inidir_one, override_dirs=[inidir_two]) + c.process() + r = c.get('FOO_BAR') + self.assertEqual(r, 'plugh') + r = c.get('FOO_BAZ') + self.assertEqual(r, '42') + r = c.get('FOO_BAH') + self.assertEqual(r, None) + r = c.get('BAR_ONE') + self.assertEqual(r, 'three') + + + def test_parse_two_schema_error(self): + inidir_one = os.path.join(self.wd, 'files', 'multi', 'one') + inidir_two = os.path.join(self.wd, 'files', 'multi', 'three') + c = Config(inidir_one, override_dirs=[inidir_two]) + with self.assertRaises(KeyError): + c.process() + + + +if __name__ == '__main__': + unittest.main() diff --git a/tests/test_translate.py b/tests/test_translate.py @@ -0,0 +1,49 @@ +# standard imports +import os +import unittest +import logging + +# local imports +from confini import Config + +logging.basicConfig(level=logging.DEBUG) +logg = logging.getLogger() + + +class TestTranslate(unittest.TestCase): + + wd = os.path.dirname(__file__) + + def setUp(self): + pass + + + def tearDown(self): + pass + + + def test_parse_default(self): + inidir = os.path.join(self.wd, 'files/translate') + c = Config(inidir) + c.process() + + self.assertTrue(c.get('TRUE_A')) + self.assertTrue(c.get('TRUE_B')) + self.assertTrue(c.get('TRUE_C')) + + self.assertFalse(c.true('FALSE_A')) + self.assertFalse(c.true('FALSE_B')) + self.assertFalse(c.true('FALSE_C')) + self.assertIsNone(c.get('FALSE_D')) + + o = { + 'TRUE_A': True, + 'FALSE_A': False, + } + c.dict_override(o, 'test') + self.assertTrue(c.true('TRUE_A')) + self.assertFalse(c.true('FALSE_A')) + + +if __name__ == '__main__': + unittest.main()