diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..89af8cf --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributing + +Contributions are welcome! Please feel free to open a PR or an issue on GitHub. + +Convention for this repository is to fork it, create a branch `feature/` on your fork, and commit changes +there. Once your changes are ready to merge back into this repository, open a PR from your repository's feature branch +into the `main` branch of this repository. Please be sure to rebase onto the main branch before submitting a PR to keep +a clean history. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..b93c2ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- +**Version** +Please include the version you are experiencing issues with. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..11fc491 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/funding.yml b/.github/funding.yml new file mode 100644 index 0000000..15e3cf1 --- /dev/null +++ b/.github/funding.yml @@ -0,0 +1,2 @@ +github: [viertaxa] +custom: 'https://paypal.me/viertaxa' \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3fd95f7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,73 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at conduct@viertaxa.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md index a3b8660..2f99991 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,56 @@ # CUP -The **C**loudFlare **U**pdater **P**rogram +The **C**loudflare (DNS) **U**pdater **P**rogram -CUP is a tool to turn CloudFlare DNS into a Dynamic DNS service. \ No newline at end of file +CUP is a tool to turn CloudFlare DNS into a Dynamic DNS service. + +# Contributing + +Contributions are welcome! Please feel free to open a PR or an issue on GitHub. + +Convention for this repository is to fork it, create a branch `feature/` on your fork, +and commit changes there. Once your changes are ready to merge back into this repository, squash your feature +branch into one commit with a descriptive commit message and open a PR from your repository's feature branch into the +`main` branch of this repository. Please also be sure to make sure your `main` branch is up to date with `main` on this +repo, and rebase your feature onto the tip of `main`. + +## Special Thanks + +Special thanks goes to the following services, which are used by default by CUP: +- [ipify](https://www.ipify.org/) +- [SeeIP](https://seeip.org/) +- [WhatIsMyIPAddress](https://whatismyipaddress.com/) + +# Sponsoring + +Your sponsorship is appreciated and helps to directly fund further development on projects like this. + +You can sponsor on a recurring basis through GitHub sponsors in the right sidebar, just hit the :heart: icon. + +Alternately, you can do sponsorships through PayPal, Bitcoin, or Ethereum. + +PayPal: [https://paypal.me/viertaxa](https://paypal.me/viertaxa) + +BTC: `bc1qev8rmfmrmxlzdhvp3p76na86gk883c5nxwa9rc` + +ETH: `0xb4a77daDB218cAd59A9cfe02B252282091CbdFA4` + +# License Information + +> Copyright 2021 Taylor Vierrether +> +> 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. +> +> A full copy of the GNU GPL v3 license is provided within the LICENSE file at the root of the repository. + +## Additional Disclaimer + +I have no association with Cloudflare, other than being a happy free-tier customer for many years. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..bfc0cf0 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,5 @@ +# Security Policy + +## Reporting a Vulnerability + +To report a security vulnerability, please **do not** open an issue. Instead, please email security_reports@viertaxa.com with a subject beginning with `[SECURITY REPORT]`. All other emails are subject to be ignored. diff --git a/cmd/cup/cup-configure.go b/cmd/cup/cup-configure.go new file mode 100644 index 0000000..22a403c --- /dev/null +++ b/cmd/cup/cup-configure.go @@ -0,0 +1,173 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package main + +import ( + log "github.com/sirupsen/logrus" + "github.com/spf13/cobra" + "github.com/spf13/viper" + "github.com/viertaxa/cup/internal/commands" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/util" + "os" +) + +// Define the `configure` command. It's used to generate or update the configuration file. +var configureCmd = &cobra.Command{ + Use: "configure [domain]", + Short: "Configure CUP.", + Long: "Configure CUP with Cloudflare credentials and tell it what hosts on what domains should be updated to the " + + "current public IP.", + Run: executeConfigure, + // Enable flags from the root command + TraverseChildren: true, +} + +// Register the subcommand on the root command +func init() { + rootCmd.AddCommand(configureCmd) +} + +// Update or Create the configuration +func executeConfigure(_ *cobra.Command, _ []string) { + // Check if we're interactive, exit if not. Configure is only supported interactively. + isStdIn, err := util.CheckIsStdin() + if err != nil { + // There was an error checking if we're interactive, but we'll continue in case there's some weird terminal that + // is interactive but doesn't act like it. + log.Errorf("Determining if we're in an interactive shell failed. Assuming interactive\nError: %s", err) + } + if !isStdIn { + log.Fatal("We only support running the configure command in an interactive session.") + } + // Attempt to read in an existing config. If one is not found at the specified path, create it, otherwise update it. + // The config file was set earlier in execution in the initConfig() function + if err := viper.ReadInConfig(); err != nil { + // There was an error reading the config file, but that error might be that it wasn't there. + // TODO: play around with passing in the config file option and testing these failure catching mechanisms + if _, ok := err.(viper.ConfigFileNotFoundError); ok { + // The error reading the config file was indeed that it wasn't found. + // NOTE: This error only gets returned when we're using the automatic config file locating system of + // viper. If the user passes in a specific file, a general error will be returned. + // We'll set the loglevel now. There's no config file to read from, so we'll just use what the user passed + // in on the command line, or the default value if that was not done. + log.Warnf("No config file found at specified path! Creating a new one.\nError:%s", err) + createConfig() + } else { + // Something went wrong when reading the specified file, or the user passed in a config file that doesn't + // exist yet. + // Let's check to see if the file specified exists. If it doesn't we'll create it. If it does, we'll log a + // fatal error. + exists, err := util.CheckFileExists(config.FilePath) + if err != nil { + log.Fatalf("Error reading configuration file specified.\nError:%s", err) + } else { + if !exists { + log.Warnf("No config file found at specified path! Creating a new one.\nError:%s", err) + createConfig() + } else { + log.Fatalf("Config file found at %s, but we were unable to read it. Has it been hand edited?"+ + "\nError: %s", config.FilePath, err) + } + } + } + } else { + // The configuration was loaded successfully + modifyConfig() + } + // Configuration struct should be up to date now, regardless of if it was there to begin with or not. + + // Actually write the configuration to disk. + log.Infof("Writing configuration file %s to disk.", config.FilePath) + if err := viper.WriteConfigAs(config.FilePath); err != nil { + // Something went wrong writing the configuration file to disk. Prompt to dump the struct in JSON format to the + // terminal in case the user went through a log of effort creating it, and would like to make the file manually. + log.Errorf("Error writing configuration to disk!\nError: %s", err) + dumpConfigIfDesired() + // Wrap things up with a fatal error and exit + log.Fatalf("Exiting.") + } else { + // Updating the config and config file seems to have gone well. We're done now. + log.Infof("Successfully wrote config file to %s", config.FilePath) + // Exit with a success exit code. + os.Exit(0) + } +} + +func dumpConfigIfDesired() { + if shouldDump, err := util.AskUserForBool("Should we dump the config to the shell for you?", + false); err != nil { + // Error prompting if we should dump the config. Defaulting to false for security purposes. + log.Errorf("Error getting your response. We will not dump the config for security reasons."+ + "\nError:%s", err) + } else { + // Got a valid response, act accordingly + if shouldDump { + // User wants a config dump + // Get the YAML + if yaml, err := util.PrettyPrintSYaml(config.C); err != nil { + // Error getting the YAML + log.Errorf("Error when attempting to marshal config to YAML.\nError: %s", err) + } else { + // Got YAML back + log.Printf("\n%s\n", yaml) + } + } + } +} + +func createConfig() { + setLogLevel() + + // Config file was not found at given path, let's create it and warn the user that this is the case. + // Generate the configuration file + if createErr := commands.ConfigurationCreate(); createErr != nil { + // Something went wrong when creating the new configuration struct. Log it and exit. + log.Fatalf("Unable to create configuration.\nError:%s", createErr) + } + // Configuration struct was created successfully + log.Info("Config created successfully.") +} + +func modifyConfig() { + // Config file was found, lets modify it. + + // First we copy the defaults into the config struct. This handles the case where we add new config options in the + // future + config.C = config.GetDefaultCupConfig() + + // Next we unmarshal the configuration loaded from the file into our config struct since we prefer to use that + // over the viper methods to query configuration. + unmarshalErr := viper.Unmarshal(&config.C) + if unmarshalErr != nil { + // There was some sort of error unmarshalling the configuration loaded from the file into our struct. + // This was likely caused by a config file that was missing properties due to hand editing. + log.Fatalf("Unable to unmarshal config. Has it been hand edited?\nError: %s", unmarshalErr) + } + // Now that we have loaded the user's preferences from file, set the log level appropriately. + setLogLevel() + + // Update the configuration struct that we loaded previously + log.Info("Configuration file located. Modifying...") + // Set the actual used configuration file path in our configuration + config.FilePath = viper.ConfigFileUsed() + if err := commands.ConfigurationEdit(); err != nil { + // Something went wrong updating the configuration struct. + log.Fatalf("Error updating configuration file.\nError:%s", err) + } +} diff --git a/cmd/cup/cup-update.go b/cmd/cup/cup-update.go new file mode 100644 index 0000000..bbeeeba --- /dev/null +++ b/cmd/cup/cup-update.go @@ -0,0 +1,79 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package main + +import ( + log "github.com/sirupsen/logrus" + "github.com/spf13/cobra" + "github.com/spf13/viper" + "github.com/viertaxa/cup/internal/commands" + "github.com/viertaxa/cup/internal/config" + "os" +) + +// Define the `update` command. It's the `main` command that does the DNS update. +var updateCmd = &cobra.Command{ + Use: "update", + Short: "Update the specified DNS record on Cloudflare", + Long: "Queries several `What is my IP` type services for your public IP, and if there's a quorum, update the " + + "record in Cloudflare.", + Run: executeUpdate, + // Enable flags from the root command + TraverseChildren: true, +} + +// Register the subcommand on the root command +func init() { + rootCmd.AddCommand(updateCmd) +} + +// Attempt to update the DNS record with the current public IP +func executeUpdate(_ *cobra.Command, _ []string) { + // Lets read in the configuration + if err := viper.ReadInConfig(); err != nil { + // There was an error reading in the configuration + if _, ok := err.(viper.ConfigFileNotFoundError); ok { + // The error reading in the configuration was that it wasn't there. + log.Fatalf("Config file not found! Please run 'cup configure' if you haven't already.\n%s", + config.FilePath) + } else { + // There was some other error reading in the configuration file + log.Fatalf("Error reading in the configuration file!\nError: %s", err) + } + } + // Config loaded successfully + // Unmarshal the config to our config struct, since we prefer using that over the viper interface + unmarshalErr := viper.Unmarshal(&config.C) + if unmarshalErr != nil { + // Error unmarshalling the config into our struct. + log.Fatalf("Unable to unmarshal config. Has it been hand edited?\nError: %s", unmarshalErr) + } + // Now that we have the full config, set the user's preferred log level. + setLogLevel() + + // Attempt to update the DNS records specified + if err := commands.Update(CupInfo); err != nil { + // Error updating the records + log.Fatalf("Error updating DNS records!\nError: %s", err) + } else { + // Records updated successfully. Inform the user. + log.Info("Successfully updated all DNS records. Goodbye.") + // Exit success + os.Exit(0) + } +} diff --git a/cmd/cup/cup-version.go b/cmd/cup/cup-version.go new file mode 100644 index 0000000..2c0b984 --- /dev/null +++ b/cmd/cup/cup-version.go @@ -0,0 +1,40 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package main + +import ( + log "github.com/sirupsen/logrus" + "github.com/spf13/cobra" +) + +// Define the `version` command. It's just prints some compile time variables. +var versionCmd = &cobra.Command{ + Use: "version", + Short: "Print the version information", + Run: executeVersion, +} + +// Register the subcommand with the root command +func init() { + rootCmd.AddCommand(versionCmd) +} + +// Print some version information +func executeVersion(_ *cobra.Command, _ []string) { + log.Printf("Version: %s\nCommit: %s\nBuild Type: %s\n", version, commit, buildType) +} diff --git a/cmd/cup/cup.go b/cmd/cup/cup.go new file mode 100644 index 0000000..9d15476 --- /dev/null +++ b/cmd/cup/cup.go @@ -0,0 +1,99 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package main + +import ( + log "github.com/sirupsen/logrus" + "github.com/spf13/cobra" + "github.com/spf13/viper" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/types" + "os" +) + +const envPrefix = "CUP" + +// To be set by the compiler/linker at build time. +var version = "0.0.0" +var commit = "x" +var buildType string + +// To be set during Init +var CupInfo types.CupInfo + +// Create the "root command" for cobra. It doesn't do anything but print usage info. +var rootCmd = &cobra.Command{ + Use: "cup [command]", + Short: "CUP - Cloudflare (DNS) Updater Program", + Long: "CUP is a Cloudflare (DNS) Updater Program that uses the Cloudflare API and a quorum of public " + + "'What is my IP' services to create what amounts to a dynamic DNS service.", +} + +func init() { + // Generate a new CupInfo for us to inject + CupInfo = types.CupInfo{ + Version: version, + Commit: commit, + BuildType: buildType, + } + + // logrus configuration + // If we're building a development build, include the calling function in logging for debugging purposes. + if buildType == "development" { + log.SetReportCaller(true) + } + // Log to stdout rather than stderr as is the default. + log.SetOutput(os.Stdout) + // Use detailed timestamps rather than execution time. + formatter := &log.TextFormatter{ + FullTimestamp: true, + TimestampFormat: "2006-01-02-15-04-05.000-0700", + } + log.SetFormatter(formatter) + + // Cobra configuration + // Add root level flags to the root command + rootCmd.PersistentFlags().StringVar(&config.FilePath, "config", "", "Configuration "+ + "file path (default \"./cupconf.{yaml, json, toml}\")") + rootCmd.PersistentFlags().StringVar(&config.C.LogLevel, "loglevel", "", "Set the maximum log "+ + "level.") + + // Initialize Cobra/Viper + cobra.OnInitialize(initConfig) +} + +func main() { + if err := rootCmd.Execute(); err != nil { + log.Fatal(err) + } +} + +func initConfig() { + // Enable environment variable input + viper.SetEnvPrefix(envPrefix) + viper.AutomaticEnv() + + // if the config file path was not passed in, set it to the default config file path + if config.FilePath == "" { + viper.SetConfigFile(config.DefaultCupConfigPath) + config.FilePath = config.DefaultCupConfigPath + } else { + // If the config file path was passed in, tell viper look for it there. + viper.SetConfigFile(config.FilePath) + } +} diff --git a/cmd/cup/shared.go b/cmd/cup/shared.go new file mode 100644 index 0000000..c3726eb --- /dev/null +++ b/cmd/cup/shared.go @@ -0,0 +1,45 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package main + +import ( + log "github.com/sirupsen/logrus" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/util" + "strings" +) + +// Set up the log levels. Called by sub-commands +func setLogLevel() { + // Check that the user passed in a valid log level and act accordingly. + if config.C.LogLevel == "" { + // If no log level was set on the command line, and there was no config file specifying this value, go with + // something sane by default. + log.SetLevel(log.InfoLevel) + config.C.LogLevel = config.LogLevelToString(log.InfoLevel) + } else if util.StringSliceContains(config.GetValidLogLevels(), strings.ToLower(config.C.LogLevel)) { + // User's passed in log level was valid, so we use it. + // Note: We avoid logging anything other than an Error or Fatal log message prior to this call + // to avoid giving the user unwanted logs. + log.SetLevel(config.StringToLogLevel(config.C.LogLevel)) + log.Infof("Setting log level to %s", config.C.LogLevel) + } else { + // User passed in an invalid log level identifier. We don't know how to log in this case! + log.Fatalf("Error, you specified an invalid log level (%s)! Exiting.", config.C.LogLevel) + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..f878ad2 --- /dev/null +++ b/go.mod @@ -0,0 +1,12 @@ +module github.com/viertaxa/cup + +go 1.15 + +require ( + github.com/cloudflare/cloudflare-go v0.13.6 + github.com/sirupsen/logrus v1.2.0 + github.com/spf13/cobra v1.1.1 + github.com/spf13/viper v1.7.0 + gopkg.in/errgo.v2 v2.1.0 + gopkg.in/yaml.v2 v2.2.8 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..c2072cc --- /dev/null +++ b/go.sum @@ -0,0 +1,338 @@ +cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +cloud.google.com/go v0.38.0/go.mod h1:990N+gfupTy94rShfmMCWGDn0LpTmnzTp2qbd1dvSRU= +cloud.google.com/go v0.44.1/go.mod h1:iSa0KzasP4Uvy3f1mN/7PiObzGgflwredwwASm/v6AU= +cloud.google.com/go v0.44.2/go.mod h1:60680Gw3Yr4ikxnPRS/oxxkBccT6SA1yMk63TGekxKY= +cloud.google.com/go v0.45.1/go.mod h1:RpBamKRgapWJb87xiFSdk4g1CME7QZg3uwTez+TSTjc= +cloud.google.com/go v0.46.3/go.mod h1:a6bKKbmY7er1mI7TEI4lsAkts/mkhTSZK8w33B4RAg0= +cloud.google.com/go/bigquery v1.0.1/go.mod h1:i/xbL2UlR5RvWAURpBYZTtm/cXjCha9lbfbpx4poX+o= +cloud.google.com/go/datastore v1.0.0/go.mod h1:LXYbyblFSglQ5pkeyhO+Qmw7ukd3C+pD7TKLgZqpHYE= +cloud.google.com/go/firestore v1.1.0/go.mod h1:ulACoGHTpvq5r8rxGJ4ddJZBZqakUQqClKRT5SZwBmk= +cloud.google.com/go/pubsub v1.0.1/go.mod h1:R0Gpsv3s54REJCy4fxDixWD93lHJMoZTyQ2kNxGRt3I= +cloud.google.com/go/storage v1.0.0/go.mod h1:IhtSnM/ZTZV8YYJWCY8RULGVqBDmpoyjwiyrjsg+URw= +dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= +github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ= +github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= +github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= +github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= +github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= +github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod h1:3U/XgcO3hCbHZ8TKRvWD2dDTCfh9M9ya+I9JpbB7O8o= +github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmVTwzkszR9V5SSuryQ31EELlFMUz1kKyl939pY= +github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= +github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= +github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= +github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs= +github.com/bketelsen/crypt v0.0.3-0.20200106085610-5cbc8cc4026c/go.mod h1:MKsuJmJgSg28kpZDP6UIiPt0e0Oz0kqKNGyRaWEPv84= +github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc= +github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= +github.com/cloudflare/cloudflare-go v0.13.6 h1:G6aw092fOkvkHODCxf8EHLPqHN2BVxHU4RoTFjS51xo= +github.com/cloudflare/cloudflare-go v0.13.6/go.mod h1:gNGW6MkPPVLhjgaXq4vaS7WnTaQpCfl6DE1W9JuWyt8= +github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= +github.com/coreos/etcd v3.3.13+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE= +github.com/coreos/go-semver v0.3.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk= +github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= +github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= +github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no= +github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= +github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= +github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= +github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= +github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= +github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= +github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= +github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= +github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= +github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= +github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= +github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= +github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg= +github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= +github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= +github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= +github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs= +github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk= +github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY= +github.com/hashicorp/consul/api v1.1.0/go.mod h1:VmuI/Lkw1nC05EYQWNKwWGbkg+FbDBtguAZLlVdkD9Q= +github.com/hashicorp/consul/sdk v0.1.1/go.mod h1:VKf9jXwCTEY1QZP2MOLRhb5i/I/ssyNV1vwHyQBF0x8= +github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= +github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= +github.com/hashicorp/go-immutable-radix v1.0.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60= +github.com/hashicorp/go-msgpack v0.5.3/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM= +github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk= +github.com/hashicorp/go-rootcerts v1.0.0/go.mod h1:K6zTfqpRlCUIjkwsN4Z+hiSfzSTQa6eBIzfwKfwNnHU= +github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= +github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= +github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= +github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= +github.com/hashicorp/go.net v0.0.1/go.mod h1:hjKkEWcCURg++eb33jQU7oqQcI9XDCnUzHA0oac0k90= +github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4= +github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= +github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= +github.com/hashicorp/mdns v1.0.0/go.mod h1:tL+uN++7HEJ6SQLQ2/p+z2pH24WQKWjBPkE0mNTz8vQ= +github.com/hashicorp/memberlist v0.1.3/go.mod h1:ajVTdAv/9Im8oMAAj5G31PhhMCZJV2pPBoIllUwCN7I= +github.com/hashicorp/serf v0.8.2/go.mod h1:6hOLApaqBFA1NXqRQAsxw9QxuDEvNxSQRwA/JwenrHc= +github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM= +github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= +github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= +github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= +github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= +github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo= +github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= +github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= +github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= +github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= +github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk= +github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= +github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/magiconair/properties v1.8.1 h1:ZC2Vc7/ZFkGmsVC9KvOjumD+G5lXy2RtTKyzRKO2BQ4= +github.com/magiconair/properties v1.8.1/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= +github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU= +github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4= +github.com/mattn/go-runewidth v0.0.7/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= +github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= +github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg= +github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc= +github.com/mitchellh/go-homedir v1.0.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= +github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= +github.com/mitchellh/go-testing-interface v1.0.0/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= +github.com/mitchellh/gox v0.4.0/go.mod h1:Sd9lOJ0+aimLBi73mGofS1ycjY8lL3uZM3JPS42BGNg= +github.com/mitchellh/iochan v1.0.0/go.mod h1:JwYml1nuB7xOzsp52dPpHFffvOCDupsG0QubkSMEySY= +github.com/mitchellh/mapstructure v0.0.0-20160808181253-ca63d7c062ee/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= +github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE= +github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= +github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= +github.com/olekukonko/tablewriter v0.0.4/go.mod h1:zq6QwlOf5SlnkVbMSr5EoBv3636FWnp+qbPhuoO21uA= +github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc= +github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc= +github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI= +github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= +github.com/prometheus/client_golang v0.9.3/go.mod h1:/TN21ttK/J9q6uSwhBd54HahCDft0ttaMvbicHlPoso= +github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= +github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro= +github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= +github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU= +github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg= +github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= +github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= +github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc= +github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= +github.com/sirupsen/logrus v1.2.0 h1:juTguoYk5qI21pwyTXY3B3Y5cOTH3ZUyZCg1v/mihuo= +github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= +github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= +github.com/smartystreets/goconvey v1.6.4 h1:fv0U8FUIMPNf1L9lnHLvLhgicrIVChEkdzIKYqbNC9s= +github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA= +github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM= +github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= +github.com/spf13/afero v1.1.2 h1:m8/z1t7/fwjysjQRYbP0RD+bUIF/8tJwPdEZsI83ACI= +github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ= +github.com/spf13/cast v1.3.0 h1:oget//CVOEoFewqQxwr0Ej5yjygnqGkvggSE/gB35Q8= +github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= +github.com/spf13/cobra v1.1.1 h1:KfztREH0tPxJJ+geloSLaAkaPkr4ki2Er5quFV1TDo4= +github.com/spf13/cobra v1.1.1/go.mod h1:WnodtKOvamDL/PwE2M4iKs8aMDBZ5Q5klgD3qfVJQMI= +github.com/spf13/jwalterweatherman v1.0.0 h1:XHEdyB+EcvlqZamSM4ZOMGlc93t6AcsBEu9Gc1vn7yk= +github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo= +github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/viper v1.7.0 h1:xVKxvI7ouOI5I+U9s2eeiUfMaWBVoXA3AWskkrqK0VM= +github.com/spf13/viper v1.7.0/go.mod h1:8WkrPz2fc9jxqZNCJI/76HCieCp4Q8HaLFoCha5qpdg= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/subosito/gotenv v1.2.0 h1:Slr1R9HxAlEKefgq5jn9U+DnETlIUa6HfgEzj0g5d7s= +github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw= +github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= +github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI= +github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU= +go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU= +go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU= +go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8= +go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= +go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0= +go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= +golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5 h1:58fnuSXlxZmFdJyvtTFVmVhcMLU6v5fEb/ok4wyqtNU= +golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9 h1:psW17arqaxU48Z5kZ0CQnkZWQJsqcURM6tKiBApRjXI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= +golang.org/x/exp v0.0.0-20190829153037-c13cbed26979/go.mod h1:86+5VVa7VpoJ4kLfm080zCjGlMRFzhUhsZKEZO7MGek= +golang.org/x/exp v0.0.0-20191030013958-a1ab85dbe136/go.mod h1:JXzH8nQsPlswgeRAPE3MuO9GYsAcnJvJ4vnMwN/5qkY= +golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= +golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= +golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= +golang.org/x/lint v0.0.0-20190301231843-5614ed5bae6f/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20190409202823-959b441ac422/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20190909230951-414d861bb4ac/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= +golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o= +golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc= +golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY= +golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181023162649-9b4f9f5ad519/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181201002055-351d144fa1fc/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190501004415-9ce7a6920f09/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20201202161906-c7110b5ffcbb h1:eBmm0M9fYhWpKZLjQUUKka/LtIxf46G4fxeEz5KJr9U= +golang.org/x/net v0.0.0-20201202161906-c7110b5ffcbb/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= +golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= +golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180823144017-11551d06cbcc/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181026203630-95b1ffbd15a5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190502145724-3ef323f4f1fd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0 h1:HyfiK1WMnHj5FXFXatD+Qs1A/xC2Run6RzeW1SyHxpc= +golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f h1:+Nyd8tzPX9R7BWHguqsrbFdRx3WQ/1ib8I44HXV5yTA= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20200630173020-3af7569d3a1e h1:EHBhcS0mlXEAVwNyO2dLfjToGsyY4j24pTs2ScHnX7s= +golang.org/x/time v0.0.0-20200630173020-3af7569d3a1e/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190312170243-e65039ee4138/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190506145303-2d16b83fe98c/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190816200558-6889da9d5479/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20190911174233-4f2ddba30aff/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191112195655-aa38f8e97acc/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/api v0.4.0/go.mod h1:8k5glujaEP+g9n7WNsDg8QP6cUVNI86fCNMcbazEtwE= +google.golang.org/api v0.7.0/go.mod h1:WtwebWUNSVBH/HAw79HIFXZNqEvBhG+Ra+ax0hx3E3M= +google.golang.org/api v0.8.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg= +google.golang.org/api v0.9.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg= +google.golang.org/api v0.13.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI= +google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= +google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/appengine v1.5.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/appengine v1.6.1/go.mod h1:i06prIuMbXzDqacNJfV5OdTW448YApPu5ww/cMBSeb0= +google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= +google.golang.org/genproto v0.0.0-20190307195333-5fe7a883aa19/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190418145605-e7d98fc518a7/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190425155659-357c62f0e4bb/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190502173448-54afdca5d873/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190801165951-fa694d86fc64/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20190911173649-1774047e7e51/go.mod h1:IbNlFCBrqXvoKpeg0TB2l7cyZUmoaFKYIwrEpbDKLA8= +google.golang.org/genproto v0.0.0-20191108220845-16a3f7862a1a/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= +google.golang.org/grpc v1.20.1/go.mod h1:10oTOabMzJvdu6/UiuZezV6QK5dSlG84ov/aaiqXj38= +google.golang.org/grpc v1.21.1/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM= +gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/errgo.v2 v2.1.0 h1:0vLT13EuvQ0hNvakwLuFZ/jYrLp5F3kcWHXdRggjCE8= +gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= +gopkg.in/ini.v1 v1.51.0 h1:AQvPpx3LzTDM0AjnIRlVFwFFGC+npRopjZxLJj6gdno= +gopkg.in/ini.v1 v1.51.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= +gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= +gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= +rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= diff --git a/internal/cfutils/check-token-active.go b/internal/cfutils/check-token-active.go new file mode 100644 index 0000000..8999bce --- /dev/null +++ b/internal/cfutils/check-token-active.go @@ -0,0 +1,40 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package cfutils + +import ( + "github.com/cloudflare/cloudflare-go" + log "github.com/sirupsen/logrus" + "time" +) + +const cfActiveTokenStatus = "active" + +func CheckKeyIsActive(cf *cloudflare.API) (bool, error) { + token, err := cf.VerifyAPIToken() + if err != nil { + return false, err + } + log.Debugf("API Token %s is %s, became valid on %s, and expires/expired on %s", token.ID, token.Status, + token.NotBefore.Format(time.RFC1123), token.ExpiresOn.Format(time.RFC1123)) + + if token.Status != cfActiveTokenStatus { + return false, nil + } + return true, nil +} diff --git a/internal/cfutils/zone.go b/internal/cfutils/zone.go new file mode 100644 index 0000000..6fa82e8 --- /dev/null +++ b/internal/cfutils/zone.go @@ -0,0 +1,41 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package cfutils + +import ( + "github.com/cloudflare/cloudflare-go" + log "github.com/sirupsen/logrus" + "github.com/viertaxa/cup/internal/config" + "gopkg.in/errgo.v2/fmt/errors" +) + +func GetZoneID(domain config.DomainConfig, cf *cloudflare.API) (string, error) { + // Get the zone object so we can get it's ID + zones, err := cf.ListZones(domain.Domain) + if err != nil { + return "", err + } + log.Debugf("Got %d zones matching %s", len(zones), domain.Domain) + if len(zones) != 1 { + return "", errors.Newf("got %d zones matching %s. Please file a bug report on GitHub if you believe "+ + "this to be incorrect", len(zones), domain.Domain) + } + zone := zones[0] + log.Debugf("Got zone ID %s for domain %s", zone.ID, zone.Name) + return zone.ID, nil +} \ No newline at end of file diff --git a/internal/commands/configure-ui.go b/internal/commands/configure-ui.go new file mode 100644 index 0000000..d0cc26f --- /dev/null +++ b/internal/commands/configure-ui.go @@ -0,0 +1,316 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package commands + +import ( + log "github.com/sirupsen/logrus" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/util" + "strings" +) + +// Get the user's desired loglevel +func promptLogLevel(existingOrDefault string) string { + // Loop until we get something satisfactory + for { + log.Println("Please enter the log level you would like cup to operate at.") + log.Printf("Valid values are: %s", strings.Join(config.GetValidLogLevels(), ", ")) + response, err := util.AskUserForString("Level", existingOrDefault) + if err != nil { + log.Errorf("Error getting your response. Please try again.\n%s", err) + } else if util.StringSliceContains(config.GetValidLogLevels(), strings.ToLower(response)) { + return strings.ToLower(response) + } else { + log.Errorf("%s is not a valid log level. Please try again.", response) + } + } +} + +// Get the desired baseurl +func promptApiBaseUrl(existingOrDefault string) string { + //Loop until we get something satisfactory + for { + log.Println("Please enter the base URL for the CloudFlare API.") + log.Println("Unless you really know what you're doing, please leave the default by pressing the " + + "ENTER/RETURN key. If you provide a value, do not include a trailing `/`.") + response, err := util.AskUserForString("API Base", existingOrDefault) + if err != nil { + log.Errorf("Error getting your response. Please try again.\nError: %s", err) + } + // Check for HTTPS. Not only is it a good idea, but Cloudflare rejects http connections. + if strings.HasPrefix(strings.ToLower(response), "https://") { + return strings.ToLower(response) + } else { + log.Warnf("%s does not begin with 'https://'. This will not work with the cloudflare API. "+ + "Continue anyways?", response) + shouldContinue, err := util.AskUserForBool("Continue?", false) + if err != nil { + log.Errorf("Error getting your response.\nError:%s", err) + } else { + if shouldContinue { + return strings.ToLower(response) + } + } + } + } +} + +// Get the user's API key +func promptAPIKey(existingOrDefault string) string { + // Loop until we get something satisfactory + for { + log.Println("Please enter the API Key you will be using") + response, err := util.AskUserForString("API Key", existingOrDefault) + if err != nil { + log.Errorf("Error getting your response. Please try again.\n%s", err) + } else { + return response + } + } +} + +// Get the list of hosts and their domains to update +func promptDomainsAndHosts(existingOrDefault []config.DomainConfig) []config.DomainConfig { + var newDomainsAndHosts []config.DomainConfig + + // Loop over the existing or example configuration. + for index, domainConfig := range existingOrDefault { + // Loop on the domain entry until it is successfully updated or the user deletes it. + for { + var updatedDomain string + var updatedHosts []string + + // If we're configuring a domain of index 1 or higher, allow the user to remove the domain from the config + if index != 0 { + log.Printf("Moving on to domain #%d, %s, with hosts: %s", index+1, domainConfig.Domain, + strings.Join(domainConfig.Hosts, ",")) + keep, err := util.AskUserForBool("Should we keep this domain in the config?", true) + if err != nil { + log.Errorf("Error getting your response, please try again.\nError: %s", err) + continue + } else { + if !keep { + // Move on to the next domain without appending this domain to newDomainsAndHosts + break + } + } + } + // Gather info on the domain we're iterating on + log.Println("Please enter the domain you will be controlling records on.") + domainResponse, err := util.AskUserForString("Domain", domainConfig.Domain) + if err != nil { + log.Errorf("Error getting your response. Please try again.\nError: %s", err) + continue + } else { + updatedDomain = strings.ToLower(domainResponse) + } + + // Move on to getting the list of hosts + log.Println("Please enter a comma separated list of hosts that should be updated. Use @ for the " + + "root domain") + hostResponse, err := util.AskUserForString("Hosts", strings.Join(domainConfig.Hosts, ",")) + if err != nil { + log.Errorf("Error getting your response. Please try again.\nError: %s", err) + continue + } else { + updatedHosts = strings.Split(strings.ReplaceAll(hostResponse, " ", ""), ",") + } + // Add the information to the new list of domains to be updated + newDomainsAndHosts = append(newDomainsAndHosts, config.DomainConfig{ + Domain: updatedDomain, + Hosts: updatedHosts, + }) + // We're done with this domain, so move on. + break + } + } + // Allow user to enter additional domains + for { + add, err := util.AskUserForBool("Should we add an additional domain?", false) + if err != nil { + log.Errorf("Error getting your response, please try again.\n%s", err) + continue + } else { + if !add { + // Don't want to add another, move on. + break + } + } + + // Does want to add another + var thisDomain string + var thisHosts []string + + var exampleDomainConfig = config.GetDefaultCupConfig().Domains[0] + + // Gather info on the new domain to be added + log.Println("Please enter the domain you will be controlling records on.") + domainResponse, err := util.AskUserForString("Domain", exampleDomainConfig.Domain) + if err != nil { + log.Errorf("Error getting your response. Please try again.\n%s", err) + continue + } else { + thisDomain = strings.ToLower(domainResponse) + } + + // Gather the info on the hosts to be added + log.Println("Please enter a comma separated list of hosts that should be updated. Use @ for the root " + + "domain") + hostResponse, err := util.AskUserForString("Hosts", strings.Join(exampleDomainConfig.Hosts, ",")) + if err != nil { + log.Errorf("Error getting your response. Please try again.\n%s", err) + continue + } else { + thisHosts = strings.Split(strings.ReplaceAll(hostResponse, " ", ""), ",") + } + newDomainsAndHosts = append(newDomainsAndHosts, config.DomainConfig{ + Domain: thisDomain, + Hosts: thisHosts, + }) + } + return newDomainsAndHosts +} + +// Get the list of hosts and their domains to update +func promptSimpleIPServices(existingOrDefault []config.SimpleIPReporterConfig) []config.SimpleIPReporterConfig { + var newSimpleIPReporterServices []config.SimpleIPReporterConfig + + // Loop over the existing or example configuration. + for index, svc := range existingOrDefault { + // Loop on the domain entry until it is successfully updated or the user deletes it. + for { + var updatedApiUrl string + var updatedSvcName string + + // If we're configuring a service of index 1 or higher, allow the user to remove the service from the config + if index != 0 { + log.Printf("Moving on to service #%d, %s", index+1, svc.ServiceName) + keep, err := util.AskUserForBool("Should we keep this service in the config?", true) + if err != nil { + log.Errorf("Error getting your response, please try again.\nError: %s", err) + continue + } else { + if !keep { + // Move on to the next service without appending this one to newSimpleIPReporterServices + break + } + } + } + // Gather info on the domain we're iterating on + log.Println("Please enter the name of the IP Reporting Service.") + serviceNameResponse, err := util.AskUserForString("Service Name", svc.ServiceName) + if err != nil { + log.Errorf("Error getting your response. Please try again.\nError: %s", err) + continue + } else { + updatedSvcName = serviceNameResponse + } + + // Get the API Base + log.Println("Please enter the API Base URL for this service.") + hostResponse, err := util.AskUserForString("API Base", svc.IPv4ApiBase) + if err != nil { + log.Errorf("Error getting your response. Please try again.\nError: %s", err) + continue + } else { + // Check for HTTPS. Not only is it a good idea, but Cloudflare rejects http connections. + if strings.HasPrefix(strings.ToLower(hostResponse), "https://") { + updatedApiUrl = strings.ToLower(hostResponse) + } else { + log.Warnf("%s does not begin with 'https://'. This is highly insecure. "+ + "Continue anyways?", hostResponse) + shouldContinue, err := util.AskUserForBool("Continue?", false) + if err != nil { + log.Errorf("Error getting your response.\nError:%s", err) + } else { + if shouldContinue { + updatedApiUrl = strings.ToLower(hostResponse) + } + } + } + } + // Add the information to the new list of domains to be updated + newSimpleIPReporterServices = append(newSimpleIPReporterServices, config.SimpleIPReporterConfig{ + ServiceName: updatedSvcName, + IPv4ApiBase: updatedApiUrl, + }) + // We're done with this service, so move on. + break + } + } + // Allow user to enter additional services + for { + add, err := util.AskUserForBool("Should we add an additional service?", false) + if err != nil { + log.Errorf("Error getting your response, please try again.\n%s", err) + continue + } else { + if !add { + // Don't want to add another, move on. + break + } + } + + // Does want to add another + var updatedApiUrl string + var updatedSvcName string + + // Gather info on the domain we're iterating on + log.Println("Please enter the name of the IP Reporting Service you wish to use.") + serviceNameResponse, err := util.AskUserForString("Service Name", config.GetDefaultCupConfig(). + SimpleIPReportServices[0].ServiceName) + if err != nil { + log.Errorf("Error getting your response. Please try again.\nError: %s", err) + continue + } else { + updatedSvcName = serviceNameResponse + } + + // Get the API Base + log.Println("Please enter the API Base URL for this service.") + hostResponse, err := util.AskUserForString("API Base", config.GetDefaultCupConfig(). + SimpleIPReportServices[0].IPv4ApiBase) + if err != nil { + log.Errorf("Error getting your response. Please try again.\nError: %s", err) + continue + } else { + // Check for HTTPS. + if strings.HasPrefix(strings.ToLower(hostResponse), "https://") { + updatedApiUrl = strings.ToLower(hostResponse) + } else { + log.Warnf("%s does not begin with 'https://'. This is highly insecure. "+ + "Continue anyways?", hostResponse) + shouldContinue, err := util.AskUserForBool("Continue?", false) + if err != nil { + log.Errorf("Error getting your response.\nError:%s", err) + } else { + if shouldContinue { + updatedApiUrl = strings.ToLower(hostResponse) + } + } + } + } + // Add the information to the new list of domains to be updated + newSimpleIPReporterServices = append(newSimpleIPReporterServices, config.SimpleIPReporterConfig{ + ServiceName: updatedSvcName, + IPv4ApiBase: updatedApiUrl, + }) + // We're done with this service, so move on. + } + return newSimpleIPReporterServices +} \ No newline at end of file diff --git a/internal/commands/configure.go b/internal/commands/configure.go new file mode 100644 index 0000000..04fca56 --- /dev/null +++ b/internal/commands/configure.go @@ -0,0 +1,78 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package commands + +import ( + log "github.com/sirupsen/logrus" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/util" +) + +// Populate the configuration struct +func ConfigurationCreate() error { + log.Info("Creating a new configuration") + + // Start prompting the user for overall configuration values + config.C.LogLevel = promptLogLevel(config.C.LogLevel) + config.C.API.ApiBaseUrl = promptApiBaseUrl(config.GetDefaultCupConfig().API.ApiBaseUrl) + config.C.API.ApiKey = promptAPIKey(config.GetDefaultCupConfig().API.ApiKey) + + log.Info("We will now begin setting up the services we will use to determine your public IP.") + // Prompt user for what IP Reporting services we should use + config.C.SimpleIPReportServices = promptSimpleIPServices(config.GetDefaultCupConfig().SimpleIPReportServices) + + // Start prompting for domain/host configuration + log.Info("We will now begin setting up domains and hosts.") + config.C.Domains = promptDomainsAndHosts(config.GetDefaultCupConfig().Domains) + + // Back-populate viper with the configuration struct so we can later save it to disk + if err := util.LoadViperConfigFromStruct(config.C); err != nil { + // Error populating viper, pass the error along. + return err + } else { + // Config struct populated and viper populated successfully + return nil + } +} + +// Update an existing configuration +func ConfigurationEdit() error { + log.Infof("Modifying existing configuration at %s.", config.FilePath) + + // Start prompting the user for overall configuration values + config.C.LogLevel = promptLogLevel(config.C.LogLevel) + config.C.API.ApiBaseUrl = promptApiBaseUrl(config.C.API.ApiBaseUrl) + config.C.API.ApiKey = promptAPIKey(config.C.API.ApiKey) + + log.Info("We will now begin setting up the services we will use to determine your public IP.") + // Prompt user for what IP Reporting services we should use + config.C.SimpleIPReportServices = promptSimpleIPServices(config.C.SimpleIPReportServices) + + // Start prompting for domain/host configuration + log.Println("We will now begin setting up domains and hosts.") + config.C.Domains = promptDomainsAndHosts(config.C.Domains) + + // Back-populate viper with the configuration struct so we can later save it to disk + if err := util.LoadViperConfigFromStruct(config.C); err != nil { + // Error populating viper, pass the error along. + return err + } else { + // Config struct populated and viper populated successfully + return nil + } +} diff --git a/internal/commands/update.go b/internal/commands/update.go new file mode 100644 index 0000000..d735351 --- /dev/null +++ b/internal/commands/update.go @@ -0,0 +1,131 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package commands + +import ( + "errors" + "github.com/cloudflare/cloudflare-go" + log "github.com/sirupsen/logrus" + "github.com/viertaxa/cup/internal/cfutils" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/externalip" + "github.com/viertaxa/cup/internal/types" +) + +func Update(cupInfo types.CupInfo) error { + // Get our external IP + ip, err := externalip.GetExternalIP(cupInfo) + if err != nil || ip == nil { + log.Error("Error getting external IP.") + return err + } + log.Debugf("Successfully got public IP: %s", ip.IPv4) + + // Create a CloudFlare API Client + cf, err := cloudflare.NewWithAPIToken(config.C.API.ApiKey, + func(api *cloudflare.API) error { + api.BaseURL = config.C.API.ApiBaseUrl + return nil + }) + if err != nil { + return err + } + + // Check that the provided API Key is valid + valid, err := cfutils.CheckKeyIsActive(cf) + if err != nil { + log.Error("Unable to check API key validity") + return err + } + if !valid { + log.Error("API Key is not active. Can't continue.") + return errors.New("api key is not active") + } + + // For each configured Domain, updated the specified hosts + // We'll not bubble up and errors in an attempt to updates as many hosts as possible in the event of a failure + for _, domain := range config.C.Domains { + // Get the zone ID for the domain + zoneID, err := cfutils.GetZoneID(domain, cf) + if err != nil { + log.Errorf("Error listing zone for domain `%s\nError:%s`", domain.Domain, err) + continue + } + + // Update each host record + for _, host := range domain.Hosts { + // Get the host ID for each host + + // The CF API has the whole domain as the name value for hosts. Generate that value. + var apiNameValue string + if host == "@" { + apiNameValue = domain.Domain + } else { + apiNameValue = host + "." + domain.Domain + } + log.Debugf("API Name Value for %s is %s", host, apiNameValue) + + // Generate a DNSRecord for us to use as filter parameters + filterRecord := cloudflare.DNSRecord{ + // Get only A records + Type: "A", + Name: apiNameValue, + } + + // Request the records matching the host + // Note that multiple are able to be returned if the user has defined multiple IPs (i.e. for round robin) + // within Cloudflare. + records, err := cf.DNSRecords(zoneID, filterRecord) + if err != nil { + log.Errorf("Error getting DNS records matching %s\nError: %s", host, err) + continue + } + + // Make sure we only got back one record. + if len(records) != 1 { + log.Errorf("There were %d records found for %s. We only support hosts with a single record in "+ + "this tool.", len(records), host) + continue + } + record := records[0] + log.Debugf("Got host record with ID %s for host %s, current value %s", + record.ID, record.Name, record.Content) + + // If the value that's currently in Cloudflare does not match the public IP that we determined, update it + if record.Content != ip.IPv4 { + // Generate a partial record to update with + newRecord := cloudflare.DNSRecord{ + Content: ip.IPv4, + } + + // Send the record to Cloudflare + err = cf.UpdateDNSRecord(zoneID, record.ID, newRecord) + if err != nil { + log.Errorf("Error updating IP for host\nError: %s", err) + continue + } else { + log.Infof("Succsfully updated record for host %s with ip %s", host, ip.IPv4) + } + } else { + // Don't need to update, won't try to not be abusive to the API + log.Info("DNS Record already matches the public IP. Not updating.") + } + } + } + return nil +} diff --git a/internal/config/config.go b/internal/config/config.go new file mode 100644 index 0000000..ddce7e2 --- /dev/null +++ b/internal/config/config.go @@ -0,0 +1,74 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package config + +var C CupConfig +var FilePath string + +const DefaultCupConfigPath = "./cupconf.yaml" + +type ( + CupConfig struct { + LogLevel string `json:"logLevel"` + API ApiConfig `json:"api"` + Domains []DomainConfig `json:"domains"` + SimpleIPReportServices []SimpleIPReporterConfig `json:"simpleIpReportServices"` + } + ApiConfig struct { + ApiBaseUrl string `json:"apiBaseUrl"` + ApiKey string `json:"apiKey"` + } + DomainConfig struct { + Domain string `json:"domain"` + Hosts []string `json:"hosts"` + } + SimpleIPReporterConfig struct { + IPv4ApiBase string `json:"ipv4ApiBase"` + ServiceName string `json:"serviceName"` + } +) + +func GetDefaultCupConfig() CupConfig { + return CupConfig{ + LogLevel: "info", + API: ApiConfig{ + ApiBaseUrl: "https://api.cloudflare.com/client/v4", + ApiKey: "1234567893feefc5f0q5000bfo0c38d90bbeb", + }, + Domains: []DomainConfig{ + { + Domain: "example.com", + Hosts: []string{"dynamic1", "subdynamic.host", "@"}, + }, + }, + SimpleIPReportServices: []SimpleIPReporterConfig{ + { + IPv4ApiBase: "https://api.ipify.org", + ServiceName: "ipify", + }, + { + IPv4ApiBase: "https://ip4.seeip.org", + ServiceName: "SeeIP", + }, + { + IPv4ApiBase: "https://ipv4bot.whatismyipaddress.com", + ServiceName: "WhatIsMyIPAddress", + }, + }, + } +} diff --git a/internal/config/loglevels.go b/internal/config/loglevels.go new file mode 100644 index 0000000..2851645 --- /dev/null +++ b/internal/config/loglevels.go @@ -0,0 +1,88 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package config + +import ( + log "github.com/sirupsen/logrus" + "strings" +) + +const traceConfigKey = "trace" +const debugConfigKey = "debug" +const infoConfigKey = "info" +const warnConfigKey = "warn" +const errorConfigKey = "error" +const fatalConfigKey = "fatal" +const panicConfigKey = "panic" + +func GetValidLogLevels() []string { + return []string{ + traceConfigKey, + debugConfigKey, + infoConfigKey, + warnConfigKey, + errorConfigKey, + fatalConfigKey, + panicConfigKey, + } +} + +func StringToLogLevel(str string) log.Level { + lowerStr := strings.ToLower(str) + switch lowerStr { + case traceConfigKey: + return log.TraceLevel + case debugConfigKey: + return log.DebugLevel + case infoConfigKey: + return log.InfoLevel + case warnConfigKey: + return log.WarnLevel + case errorConfigKey: + return log.ErrorLevel + case fatalConfigKey: + return log.FatalLevel + case panicConfigKey: + return log.PanicLevel + default: + // If we incorrectly check the input and end up here, return the program default of `info` + return log.InfoLevel + } +} + +func LogLevelToString(level log.Level) string { + switch level { + case log.TraceLevel: + return traceConfigKey + case log.DebugLevel: + return debugConfigKey + case log.InfoLevel: + return infoConfigKey + case log.WarnLevel: + return warnConfigKey + case log.ErrorLevel: + return errorConfigKey + case log.FatalLevel: + return fatalConfigKey + case log.PanicLevel: + return panicConfigKey + default: + // If we somehow get a different value, just return the application default log level, `info` + return infoConfigKey + } +} diff --git a/internal/config/loglevels_test.go b/internal/config/loglevels_test.go new file mode 100644 index 0000000..d4feb70 --- /dev/null +++ b/internal/config/loglevels_test.go @@ -0,0 +1,216 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package config + +import ( + "github.com/sirupsen/logrus" + "testing" +) + +func TestLogLevelToString(t *testing.T) { + type args struct { + level logrus.Level + } + tests := []struct { + name string + args args + want string + }{ + { + name: "Trace", + args: args{ + level: logrus.TraceLevel, + }, + want: "trace", + }, + { + name: "Debug", + args: args{ + level: logrus.DebugLevel, + }, + want: "debug", + }, + { + name: "Info", + args: args{ + level: logrus.InfoLevel, + }, + want: "info", + }, + { + name: "Warn", + args: args{ + level: logrus.WarnLevel, + }, + want: "warn", + }, + { + name: "Error", + args: args{ + level: logrus.ErrorLevel, + }, + want: "error", + }, + { + name: "Fatal", + args: args{ + level: logrus.FatalLevel, + }, + want: "fatal", + }, + { + name: "Panic", + args: args{ + level: logrus.PanicLevel, + }, + want: "panic", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := LogLevelToString(tt.args.level); got != tt.want { + t.Errorf("LogLevelToString() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestStringToLogLevel(t *testing.T) { + type args struct { + str string + } + tests := []struct { + name string + args args + want logrus.Level + }{ + { + name: "Trace", + args: args{ + str: "Trace", + }, + want: logrus.TraceLevel, + }, + { + name: "trace", + args: args{ + str: "trace", + }, + want: logrus.TraceLevel, + }, + { + name: "Debug", + args: args{ + str: "Debug", + }, + want: logrus.DebugLevel, + }, + { + name: "debug", + args: args{ + str: "debug", + }, + want: logrus.DebugLevel, + }, + { + name: "Info", + args: args{ + str: "Info", + }, + want: logrus.InfoLevel, + }, + { + name: "info", + args: args{ + str: "info", + }, + want: logrus.InfoLevel, + }, + { + name: "Warn", + args: args{ + str: "Warn", + }, + want: logrus.WarnLevel, + }, + { + name: "warn", + args: args{ + str: "warn", + }, + want: logrus.WarnLevel, + }, + { + name: "Error", + args: args{ + str: "Error", + }, + want: logrus.ErrorLevel, + }, + { + name: "error", + args: args{ + str: "error", + }, + want: logrus.ErrorLevel, + }, + { + name: "Fatal", + args: args{ + str: "Fatal", + }, + want: logrus.FatalLevel, + }, + { + name: "fatal", + args: args{ + str: "fatal", + }, + want: logrus.FatalLevel, + }, + { + name: "Panic", + args: args{ + str: "Panic", + }, + want: logrus.PanicLevel, + }, + { + name: "panic", + args: args{ + str: "panic", + }, + want: logrus.PanicLevel, + }, + { + name: "Default", + args: args{ + str: "foo", + }, + want: logrus.InfoLevel, + }, + + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := StringToLogLevel(tt.args.str); got != tt.want { + t.Errorf("StringToLogLevel() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/internal/externalip/clients/clients.go b/internal/externalip/clients/clients.go new file mode 100644 index 0000000..bf8917b --- /dev/null +++ b/internal/externalip/clients/clients.go @@ -0,0 +1,21 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package clients + +const userAgentHeaderKey = "User-Agent" +const maxRetries = 5 diff --git a/internal/externalip/clients/generic-ip-as-body-svc.go b/internal/externalip/clients/generic-ip-as-body-svc.go new file mode 100644 index 0000000..d6f5f8d --- /dev/null +++ b/internal/externalip/clients/generic-ip-as-body-svc.go @@ -0,0 +1,76 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package clients + +import ( + "errors" + log "github.com/sirupsen/logrus" + "github.com/viertaxa/cup/internal/types" + "github.com/viertaxa/cup/internal/util" + "io/ioutil" + "net" + "net/http" + "time" +) + +func GetHttpIpAsBodySvcIP(url string, ua string) (*types.ExternalIP, error) { + httpClient := http.Client{} + req, err := http.NewRequest(http.MethodGet, url, nil) + if err != nil { + return nil, err + } + req.Header.Add(userAgentHeaderKey, ua) + + //IPv4 request + retryDelay := util.NewRetryTimer(3, 600*time.Second) + for tries := 0; tries < maxRetries; tries++ { + if tries != 0 { + log.Warnf("Waiting %d before continuing after a failure.", int(retryDelay.GetRetryDelay().Seconds())) + } + time.Sleep(retryDelay.GetRetryDelay()) + resp, err := httpClient.Do(req) + if err != nil { + log.Errorf("Error encountered getting IP from service.\nError: %s", err) + retryDelay.AttemptFailed() + continue + } else { + body, err := ioutil.ReadAll(resp.Body) + if err != nil { + log.Error("Error decoding the response body.") + retryDelay.AttemptFailed() + continue + } + if resp.StatusCode != 200 { + + log.Errorf("Bad Response from the service.\n%d - %s", resp.StatusCode, body) + retryDelay.AttemptFailed() + continue + } else { + ip := net.ParseIP(string(body)) + if ip != nil { + return &types.ExternalIP{IPv4: ip.String()}, nil + } else { + log.Errorf("Could not parse body as IP.\nBody: %s", body) + retryDelay.AttemptFailed() + continue + } + } + } + } + return nil, errors.New("error getting ip from service, retries exceeded") +} diff --git a/internal/externalip/externalip.go b/internal/externalip/externalip.go new file mode 100644 index 0000000..d6329f7 --- /dev/null +++ b/internal/externalip/externalip.go @@ -0,0 +1,77 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package externalip + +import ( + "errors" + log "github.com/sirupsen/logrus" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/externalip/clients" + "github.com/viertaxa/cup/internal/types" + "github.com/viertaxa/cup/internal/util" +) + +func GetExternalIP(cupInfo types.CupInfo) (*types.ExternalIP, error) { + // Generate a user agent specific to this configuration, but identifiable as CUP + ua := util.GenUserAgent(cupInfo, &config.C) + + var externalIPs []types.ExternalIP + // Loop on provided Simple IP Reporting Services + for _, svc := range config.C.SimpleIPReportServices { + ip, err := clients.GetHttpIpAsBodySvcIP(svc.IPv4ApiBase, ua) + if err != nil { + log.Errorf("Error getting IP from %s.\nError: %s",svc.ServiceName, err) + } + if ip != nil { + externalIPs = append(externalIPs, *ip) + log.Debugf("Got public IP %s from ipify.", ip.IPv4) + } + } + + // Get what the consensus is for the public IP + ipv4, err := getIPConsensus(externalIPs) + if err != nil { + log.Errorf("Error getting public IP\nError: %s", err) + return nil, err + } + + return &types.ExternalIP{IPv4: ipv4}, nil +} + +// Get the consensus for what the public IP is +func getIPConsensus(externalIps []types.ExternalIP) (string, error) { + var extractedIPv4Addresses []string + + // Pull the IPv4 addresses out. + // Note: this is a bit odd for now because my IPv6 setup is broken, and I can't develop/test that part of the tool + for _, externalIp := range externalIps { + extractedIPv4Addresses = append(extractedIPv4Addresses, externalIp.IPv4) + } + + ipConsensus := util.GetStringSliceMode(extractedIPv4Addresses) + if len(ipConsensus) == 1 { + log.Infof("It's agreed, your IP is %s", ipConsensus[0]) + if util.CountOccurrences(extractedIPv4Addresses, ipConsensus[0]) != len(extractedIPv4Addresses) { + log.Warnf("Warning, not everyone agreed, though. only %d of %d thought that was the case.", + util.CountOccurrences(extractedIPv4Addresses, ipConsensus[0]), len(extractedIPv4Addresses)) + } + return ipConsensus[0], nil + } else { + return "", errors.New("could not come to a consensus on what the public IP address is") + } +} diff --git a/internal/externalip/externalip_test.go b/internal/externalip/externalip_test.go new file mode 100644 index 0000000..e580a0d --- /dev/null +++ b/internal/externalip/externalip_test.go @@ -0,0 +1,92 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package externalip + +import ( + "github.com/viertaxa/cup/internal/types" + "testing" +) + +func Test_getIPConsensus(t *testing.T) { + type args struct { + externalIps []types.ExternalIP + } + tests := []struct { + name string + args args + want string + wantErr bool + }{ + { + name: "Is Consensus", + args: args{ + externalIps: []types.ExternalIP{ + { + IPv4: "1.1.1.1", + }, + { + IPv4: "1.1.1.1", + }, + { + IPv4: "2.2.2.2", + }, + }, + }, + want: "1.1.1.1", + wantErr: false, + }, + { + name: "Isn't Consensus", + args: args{ + externalIps: []types.ExternalIP{ + { + IPv4: "1.1.1.1", + }, + { + IPv4: "3.3.3.3", + }, + { + IPv4: "2.2.2.2", + }, + }, + }, + want: "", + wantErr: true, + }, + { + name: "No values", + args: args{ + externalIps: []types.ExternalIP{}, + }, + want: "", + wantErr: true, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := getIPConsensus(tt.args.externalIps) + if (err != nil) != tt.wantErr { + t.Errorf("getIPConsensus() error = %v, wantErr %v", err, tt.wantErr) + return + } + if got != tt.want { + t.Errorf("getIPConsensus() got = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/internal/types/cup-info.go b/internal/types/cup-info.go new file mode 100644 index 0000000..e8d6b00 --- /dev/null +++ b/internal/types/cup-info.go @@ -0,0 +1,24 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package types + +type CupInfo struct { + Version string + Commit string + BuildType string +} diff --git a/internal/types/external-ip.go b/internal/types/external-ip.go new file mode 100644 index 0000000..a3fdf25 --- /dev/null +++ b/internal/types/external-ip.go @@ -0,0 +1,22 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package types + +type ExternalIP struct { + IPv4 string +} diff --git a/internal/util/file.go b/internal/util/file.go new file mode 100644 index 0000000..7de0259 --- /dev/null +++ b/internal/util/file.go @@ -0,0 +1,34 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import "os" + +func CheckFileExists(path string) (bool, error) { + // Attempt to get file stats on the file. + if _, err := os.Stat(path); os.IsNotExist(err) { + // There was an error getting the file stats, but that error was that the file isn't there. + return false, nil + } else if err != nil { + // There was some other error getting the file stats, but the file may be there. + return false, err + } else { + // The file was there and we were able to get the stats on it + return true, nil + } +} diff --git a/internal/util/retry-timer.go b/internal/util/retry-timer.go new file mode 100644 index 0000000..bbc586e --- /dev/null +++ b/internal/util/retry-timer.go @@ -0,0 +1,49 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "math" + "time" +) + +type RetryTimer struct { + attemptNo int + factor int + max time.Duration +} + +func NewRetryTimer(backoffFactor int, maxWaitTime time.Duration) RetryTimer { + return RetryTimer{ + attemptNo: 0, + factor: backoffFactor, + max: maxWaitTime, + } +} + +func (r *RetryTimer) GetRetryDelay() time.Duration { + if r.attemptNo == 0 { + return time.Duration(0) + } + delay := time.Duration(int64(math.Pow(float64(r.attemptNo), float64(r.factor)))) * time.Second + return GetSmallerDuration(r.max, delay) +} + +func (r *RetryTimer) AttemptFailed() { + r.attemptNo++ +} diff --git a/internal/util/retry-timer_test.go b/internal/util/retry-timer_test.go new file mode 100644 index 0000000..a6c4614 --- /dev/null +++ b/internal/util/retry-timer_test.go @@ -0,0 +1,77 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "testing" + "time" +) + +func TestNewRetryTimer(t *testing.T) { + timer := NewRetryTimer(3, 600*time.Second) + + if timer.attemptNo != 0 { + t.Errorf("New timer instantiated with intial counter other than 0. Actual value: %d", timer.attemptNo) + } +} + +func TestGetRetryDelay(t *testing.T) { + timer := NewRetryTimer(3, 600*time.Second) + + // RetryDelay should be 0 to begin with. + if timer.GetRetryDelay() != time.Duration(0) { + t.Errorf("Timer initial retry delay should be 0. Actual value in seconds: %d", + timer.GetRetryDelay()/time.Second) + } + + // with a factor of 3 and a max time of 600s, we should see retry delays of 1, 8, 27, 64, 125, 216, 343, 512, 600 + + expected := map[int]time.Duration{ + 0: 0 * time.Second, + 1: 1 * time.Second, + 2: 8 * time.Second, + 3: 27 * time.Second, + 4: 64 * time.Second, + 5: 125 * time.Second, + 6: 216 * time.Second, + 7: 343 * time.Second, + 8: 512 * time.Second, + 9: 600 * time.Second, + 10: 600 * time.Second, + 11: 600 * time.Second, + 12: 600 * time.Second, + 13: 600 * time.Second, + 14: 600 * time.Second, + } + + for tr := 0; tr < 15; tr++ { + if timer.GetRetryDelay() != expected[tr] { + t.Errorf("Timer retry delay should be %d seconds for attempt %d. Actual value in seconds: %d", + expected[tr]/time.Second, tr+1, timer.GetRetryDelay()/time.Second) + } + timer.AttemptFailed() + } +} + +func TestAttemptFailed(t *testing.T) { + timer := NewRetryTimer(3, 600*time.Second) + timer.AttemptFailed() + if timer.attemptNo != 1 { + t.Errorf("Timer incrimented once did not have counter of 1. Actual value: %d", timer.attemptNo) + } +} \ No newline at end of file diff --git a/internal/util/stdin.go b/internal/util/stdin.go new file mode 100644 index 0000000..4673e56 --- /dev/null +++ b/internal/util/stdin.go @@ -0,0 +1,36 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import "os" + +func CheckIsStdin() (bool,error){ + // Grab stdin and check the properties of it + if fileInfo, err := os.Stdin.Stat(); err != nil { + // We weren't able to grab stdin for some reason. + return false, err + } else { + // Since we were able to grab stdin, do the actual check. + // Do a binary AND on the ModeCharDevice bit. If it's 0/false, return false. + if (fileInfo.Mode() & os.ModeCharDevice) == 0 { + return false, nil + } else { + return true, nil + } + } +} diff --git a/internal/util/stringslice.go b/internal/util/stringslice.go new file mode 100644 index 0000000..a113854 --- /dev/null +++ b/internal/util/stringslice.go @@ -0,0 +1,68 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +//StringSliceContains returns `true` if the passed in string slice contains the +//passed in string, otherwise returns false. +func StringSliceContains(s []string, str string) bool { + for _, v := range s { + if v == str { + return true + } + } + return false +} + +func GetStringSliceMode(sl []string) []string { + if len(sl) == 0 { + return nil + } + valueMap := make(map[string]int) + for _, s := range sl { + valueMap[s]++ + } + + var maxFrequency int + for _, v := range valueMap { + if v > maxFrequency { + maxFrequency = v + } + } + + var maxValues []string + for k, v := range valueMap { + if v == maxFrequency { + maxValues = append(maxValues, k) + } + } + return maxValues +} + +func CountOccurrences(sl []string, s string) int { + if len(sl) == 0 { + return 0 + } + + var occurrences int + for _, v := range sl { + if v == s { + occurrences++ + } + } + return occurrences +} diff --git a/internal/util/stringslice_test.go b/internal/util/stringslice_test.go new file mode 100644 index 0000000..241c712 --- /dev/null +++ b/internal/util/stringslice_test.go @@ -0,0 +1,162 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "reflect" + "sort" + "testing" +) + +func TestCountOccurrences(t *testing.T) { + type args struct { + sl []string + s string + } + tests := []struct { + name string + args args + want int + }{ + { + name: "No Occurrences", + args: args{ + sl: []string{"bar", "baz"}, + s: "foo", + }, + want: 0, + }, + { + name: "1 Occurrence", + args: args{ + sl: []string{"bar", "baz", "foo"}, + s: "foo", + }, + want: 1, + }, + { + name: "3 Occurrences", + args: args{ + sl: []string{"foo", "bar", "foo", "baz", "foo"}, + s: "foo", + }, + want: 3, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := CountOccurrences(tt.args.sl, tt.args.s); got != tt.want { + t.Errorf("CountOccurrences() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestGetStringSliceMode(t *testing.T) { + type args struct { + sl []string + } + tests := []struct { + name string + args args + want []string + }{ + { + name: "All the same value", + args: args{ + sl: []string{"foo", "foo", "foo"}, + }, + want: []string{"foo"}, + }, + { + name: "Two different values with winner", + args: args{ + sl: []string{"foo", "foo", "bar"}, + }, + want: []string{"foo"}, + }, + { + name: "All different values", + args: args{ + sl: []string{"foo", "bar", "baz"}, + }, + want: []string{"foo", "bar", "baz"}, + }, + { + name: "Two winners with one loser", + args: args{ + sl: []string{"foo", "foo", "bar", "bar", "baz"}, + }, + want: []string{"foo", "bar"}, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := GetStringSliceMode(tt.args.sl) + sort.Strings(got) + sort.Strings(tt.want) + if !reflect.DeepEqual(got, tt.want) { + t.Errorf("GetStringSliceMode() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestStringSliceContains(t *testing.T) { + type args struct { + s []string + str string + } + tests := []struct { + name string + args args + want bool + }{ + { + name: "Does contain", + args: args{ + s: []string{"foo", "bar", "baz"}, + str: "bar", + }, + want: true, + }, + { + name: "Does not contain", + args: args{ + s: []string{"foo", "bar", "baz"}, + str: "bang", + }, + want: false, + }, + { + name: "Does not contain (wrong case)", + args: args{ + s: []string{"foo", "Bar", "baz"}, + str: "bar", + }, + want: false, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := StringSliceContains(tt.args.s, tt.args.str); got != tt.want { + t.Errorf("StringSliceContains() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/internal/util/time.go b/internal/util/time.go new file mode 100644 index 0000000..55d83f8 --- /dev/null +++ b/internal/util/time.go @@ -0,0 +1,28 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import "time" + +func GetSmallerDuration(d1, d2 time.Duration) time.Duration { + if d1-d2 < 0 { + return d1 + } else { + return d2 + } +} diff --git a/internal/util/time_test.go b/internal/util/time_test.go new file mode 100644 index 0000000..d4d73de --- /dev/null +++ b/internal/util/time_test.go @@ -0,0 +1,53 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "testing" + "time" +) + +func TestGetSmallerDuration(t *testing.T) { + type args struct { + d1 time.Duration + d2 time.Duration + } + tests := []struct { + name string + args args + want time.Duration + }{ + { + name: "Different Times", + args: args{d1: time.Second * 1, d2: time.Second * 2}, + want: time.Second * 1, + }, + { + name: "Same Times", + args: args{d1: time.Second * 2, d2: time.Second * 2}, + want: time.Second * 2, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := GetSmallerDuration(tt.args.d1, tt.args.d2); got != tt.want { + t.Errorf("GetSmallerDuration() = %v, want %v", got, tt.want) + } + }) + } +} \ No newline at end of file diff --git a/internal/util/user-agent.go b/internal/util/user-agent.go new file mode 100644 index 0000000..77766eb --- /dev/null +++ b/internal/util/user-agent.go @@ -0,0 +1,45 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "crypto/sha256" + "encoding/json" + "fmt" + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/types" +) + +const ConfigBytesStandin = "I am but a poor cup executable that was unable to marshal my config." + +func GenUserAgent(cupInfo types.CupInfo, cupConfig *config.CupConfig) string { + hasher := sha256.New() + configBytes, err := json.Marshal(cupConfig) + if err != nil { + hasher.Write([]byte(ConfigBytesStandin)) + } else { + hasher.Write(configBytes) + } + shaHash := hasher.Sum(nil) + + return fmt.Sprintf("cup/%s-%s (%s) instance/%x", + cupInfo.Version, + cupInfo.Commit, + cupInfo.BuildType, + shaHash) +} diff --git a/internal/util/user-agent_test.go b/internal/util/user-agent_test.go new file mode 100644 index 0000000..b7cc41d --- /dev/null +++ b/internal/util/user-agent_test.go @@ -0,0 +1,88 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "github.com/viertaxa/cup/internal/config" + "github.com/viertaxa/cup/internal/types" + "testing" +) + +func TestGenUserAgent(t *testing.T) { + type args struct { + cupInfo types.CupInfo + cupConfig *config.CupConfig + } + tests := []struct { + name string + args args + want string + }{ + { + name: "Unable to marshal config", + args: args{ + cupInfo: types.CupInfo{ + Version: "1.0.0", + Commit: "deadbeef", + BuildType: "testing", + }, + cupConfig: nil, + }, + want: "cup/1.0.0-deadbeef (testing) instance/74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b", + }, + { + name: "Valid Config", + args: args{ + cupInfo: types.CupInfo{ + Version: "1.0.0", + Commit: "deadbeef", + BuildType: "testing", + }, + cupConfig: &config.CupConfig{ + LogLevel: "trace", + API: config.ApiConfig{ + ApiBaseUrl: "https://foo.bar/", + ApiKey: "dfsadsdsafdfsdfa", + }, + Domains: []config.DomainConfig{ + { + Domain: "foo.com", + Hosts: []string{ + "bar", + }, + }, + }, + SimpleIPReportServices: []config.SimpleIPReporterConfig{ + { + IPv4ApiBase: "https://ip.foo.bar", + ServiceName: "FooBarIPReporter", + }, + }, + }, + }, + want: "cup/1.0.0-deadbeef (testing) instance/7b80fdc9cb0a664c2333cc41bb8875c5821fe1d7b4257a26c13661c363368f99", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := GenUserAgent(tt.args.cupInfo, tt.args.cupConfig); got != tt.want { + t.Errorf("GenUserAgent() = %v, want %v", got, tt.want) + } + }) + } +} \ No newline at end of file diff --git a/internal/util/user-prompt.go b/internal/util/user-prompt.go new file mode 100644 index 0000000..0d454bc --- /dev/null +++ b/internal/util/user-prompt.go @@ -0,0 +1,66 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "bufio" + "fmt" + "os" + "strings" +) + +func AskUserForString(question string, defaultValue string) (string, error) { + reader := bufio.NewReader(os.Stdin) + + fmt.Printf("%s [%s]:", question, defaultValue) + + response, err := reader.ReadString('\n') + if err != nil { + return "", err + } + if strings.TrimSpace(response) == "" { + return defaultValue, nil + } + return strings.TrimSpace(response), nil +} + +func AskUserForBool(question string, defaultValue bool) (bool, error) { + var defaultWord string + var trueResponses = []string{"y", "yes", "t", "true"} + switch defaultValue { + case true: + defaultWord = "Y" + case false: + defaultWord = "N" + } + + reader := bufio.NewReader(os.Stdin) + + fmt.Printf("%s [%s]:", question, defaultWord) + response, err := reader.ReadString('\n') + if err != nil { + return false, err + } + if strings.TrimSpace(response) == "" { + return defaultValue, nil + } + if StringSliceContains(trueResponses, strings.ToLower(strings.TrimSpace(response))) { + return true, nil + } + return false, nil +} diff --git a/internal/util/viper.go b/internal/util/viper.go new file mode 100644 index 0000000..d659c89 --- /dev/null +++ b/internal/util/viper.go @@ -0,0 +1,40 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "bytes" + "encoding/json" + "github.com/spf13/viper" +) + +// LoadViperConfigFromStruct back-populates viper with the content of a struct. +func LoadViperConfigFromStruct(cfg interface{}) error { + cfgJsonBytes, err := json.Marshal(cfg) + if err != nil { + return err + } + + viper.SetConfigType("json") + err = viper.ReadConfig(bytes.NewReader(cfgJsonBytes)) + if err != nil { + return err + } + + return nil +} diff --git a/internal/util/yaml.go b/internal/util/yaml.go new file mode 100644 index 0000000..c4d2a76 --- /dev/null +++ b/internal/util/yaml.go @@ -0,0 +1,29 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import "gopkg.in/yaml.v2" + +// PrettyPrintSYaml generates a pretty-ish YAML string +func PrettyPrintSYaml(t interface{}) (string, error) { + document, err := yaml.Marshal(t) + if err != nil { + return "", err + } + return string(document), nil +} diff --git a/internal/util/yaml_test.go b/internal/util/yaml_test.go new file mode 100644 index 0000000..91b0d02 --- /dev/null +++ b/internal/util/yaml_test.go @@ -0,0 +1,88 @@ +/* +* Copyright 2021 Taylor Vierrether +* +* 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 . +*/ + +package util + +import ( + "github.com/viertaxa/cup/internal/config" + "strings" + "testing" +) + +func TestPrettyPrintSYaml(t *testing.T) { + type args struct { + t interface{} + } + tests := []struct { + name string + args args + want string + wantErr bool + }{ + { + name: "Print a sample config", + args: args{ + t: config.CupConfig{ + LogLevel: "trace", + API: config.ApiConfig{ + ApiBaseUrl: "https://foo.bar/", + ApiKey: "dfsadsdsafdfsdfa", + }, + Domains: []config.DomainConfig{ + { + Domain: "foo.com", + Hosts: []string{ + "bar", + }, + }, + }, + SimpleIPReportServices: []config.SimpleIPReporterConfig{ + { + IPv4ApiBase: "https://ip.foo.bar", + ServiceName: "FooBarIPReporter", + }, + }, + }, + }, + want: ` +loglevel: trace +api: + apibaseurl: https://foo.bar/ + apikey: dfsadsdsafdfsdfa +domains: +- domain: foo.com + hosts: + - bar +simpleipreportservices: +- ipv4apibase: https://ip.foo.bar + servicename: FooBarIPReporter`, + wantErr: false, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := PrettyPrintSYaml(tt.args.t) + if (err != nil) != tt.wantErr { + t.Errorf("PrettyPrintSYaml() error = %v, wantErr %v", err, tt.wantErr) + return + } + if strings.TrimSpace(got) != strings.TrimSpace(tt.want) { + t.Errorf("PrettyPrintSYaml() got = %v, want %v", got, tt.want) + } + }) + } +}