From 3cd7e44cb3a1d722fb2e90d3a4fb1882afe7edc5 Mon Sep 17 00:00:00 2001 From: Beau Date: Mon, 26 Feb 2024 12:44:50 +0000 Subject: [PATCH] v0.0.1 --- .env | 1 + .github/workflows/release.yaml | 19 + .gitignore | 29 ++ LICENSE | 674 +++++++++++++++++++++++++++++++++ README.md | 110 ++++++ cmd/generate.go | 249 ++++++++++++ cmd/root.go | 56 +++ cmd/version.go | 22 ++ cmd/version_test.go | 24 ++ go.mod | 23 ++ go.sum | 52 +++ justfile | 17 + logger/logger.go | 29 ++ main.go | 19 + repocfg/project.go | 105 +++++ repocfg/project_test.go | 118 ++++++ repocfg/repocfg.go | 99 +++++ repocfg/repocfg_test.go | 100 +++++ repocfg/util.go | 68 ++++ repocfg/util_test.go | 73 ++++ repocfg/workflow.go | 175 +++++++++ repocfg/workflow_test.go | 96 +++++ 22 files changed, 2158 insertions(+) create mode 100644 .env create mode 100644 .github/workflows/release.yaml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 cmd/generate.go create mode 100644 cmd/root.go create mode 100644 cmd/version.go create mode 100644 cmd/version_test.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 justfile create mode 100644 logger/logger.go create mode 100644 main.go create mode 100644 repocfg/project.go create mode 100644 repocfg/project_test.go create mode 100644 repocfg/repocfg.go create mode 100644 repocfg/repocfg_test.go create mode 100644 repocfg/util.go create mode 100644 repocfg/util_test.go create mode 100644 repocfg/workflow.go create mode 100644 repocfg/workflow_test.go diff --git a/.env b/.env new file mode 100644 index 0000000..55e1665 --- /dev/null +++ b/.env @@ -0,0 +1 @@ +VERSION=v0.0.1 diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..c803675 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,19 @@ +on: + release: + types: [created] + +permissions: + contents: write + packages: write + +jobs: + release-linux-amd64: + name: release linux/amd64 + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: wangyoucao577/go-release-action@v1 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + goos: linux + goarch: amd64 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3d07616 --- /dev/null +++ b/.gitignore @@ -0,0 +1,29 @@ +.gitignore + +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Local build +tfvars-atlantis-config + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work + +# justfile Go tools +tools 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 new file mode 100644 index 0000000..b072db4 --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +# tfvars-atlantis-config + +

+ tfvars-atlantis-config logo

+ tfvars pre-workflow hook for Atlantis +

+ + +## Quick start +### CLI + tfvars-atlantis-config generate --automerge --autoplan --parallel --output=atlantis.yaml + +### Atlantis Server Side Config +```yaml +repos: +- id: /.*/ + pre_workflow_hooks: + - run: tfvars-atlantis-config generate --automerge --autoplan --parallel --output=atlantis.yaml +``` + + +## What is `tfvars-atlantis-config`? +Heavily inspired by +[terragrunt-atlantis-config](https://github.com/transcend-io/terragrunt-atlantis-config/), +this tool allows you to dynamically generate your +[Atlantis](https://runatlantis.io) configuration using `tfvars` instead +of environment hiearchies. + +This is useful for teams that have simple Terraform +components and don't want the added complexity of using Terragrunt or structured +environment levels. + + +### Example + +#### The following repo structure: +``` +my-terraform +├── main.tf +├── dev.tfvars +``` + +#### Generates the following Atlantis configuration: + +```yaml +version: 3 +automerge: true +parallel_plan: true +parallel_apply: true +projects: +- name: my-terraform-dev + dir: my-terraform + workflow: my-terraform-dev + autoplan: + when_modified: + - '*.tf' + - dev.tfvars + enabled: true +- name: my-terraform-prod + dir: my-terraform + workflow: my-terraform-prod + autoplan: + when_modified: + - '*.tf' + - prod.tfvars + enabled: true +workflows: + my-terraform-dev: + plan: + steps: + - init + - plan: + extra_args: + - -var-file=dev.tfvars + apply: + - apply + my-terraform-prod: + plan: + steps: + - init + - plan: + extra_args: + - -var-file=prod.tfvars + apply: + - apply +``` + +## Why you should use it? +Dynamically generate your Atlantis configuration based on your Terraform components' `.tfvars` files: +* Auto plan per environment based on the environment `.tfvars` file modified. +* Auto plan all environments when a component's Terraform code is modified (`*.tf`). +* Allow your teams to organize their Terraform components in monorepos/standalone + repositories how _they_ want, while abstracting the configuration of Atlantis + away from them, and reducing bloat in your repos. + +## Flags + +Customize the behavior of this utility through CLI flag values passed in at +runtime. + +| Flag Name | Description | Default Value | +| ----------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------- | +| `--automerge` | Enable auto merge. | false | +| `--autoplan` | Enable auto plan. | false | +| `--default-terraform-version` | Default terraform version to run for Atlantis. Default is determined by the Terraform version constraints. | "" | +| `--multienv` | Enable injection of environment specific environment variables to each workflow. | false | +| `--output` | Path of the file where configuration will be generated, usually `atlantis.yaml`. Default is to write to `stdout` | `stdout` | +| `--parallel` | Enables plans and applys to happen in parallel. | false | +| `--root` | Path to the root directory of the git repo you want to build config for. Default is current dir. | `.` | +| `--use-workspaces` | Whether to use Terraform workspaces for projects. | false | diff --git a/cmd/generate.go b/cmd/generate.go new file mode 100644 index 0000000..ff2d812 --- /dev/null +++ b/cmd/generate.go @@ -0,0 +1,249 @@ +package cmd + +import ( + "context" + "fmt" + "os" + "path/filepath" + "strings" + + "github.com/3bbbeau/tfvars-atlantis-config/logger" + "github.com/3bbbeau/tfvars-atlantis-config/repocfg" + "github.com/spf13/cobra" + "github.com/spf13/pflag" + "gopkg.in/yaml.v2" +) + +// Flags represents the flags for the `generate` command +type Flags struct { + AutoMerge bool + AutoPlan bool + DefaultTerraformVersion string + MultiEnv bool + Output string + Parallel bool + Root string + UseWorkspaces bool +} + +// NewFlags returns a default Flags struct +func NewFlags() (*Flags, error) { + pwd, err := os.Getwd() + if err != nil { + return nil, fmt.Errorf("default flags for git root: %w", err) + } + + return &Flags{ + AutoMerge: false, + AutoPlan: false, + DefaultTerraformVersion: "", + Root: pwd, + MultiEnv: false, + Output: "", + Parallel: false, + UseWorkspaces: false, + }, nil +} + +// AddFlags registers flags for the `generate` command +func (flags *Flags) AddFlags(cmd *cobra.Command) { + cmd.Flags().BoolVar(&flags.AutoPlan, "autoplan", flags.AutoPlan, "Enable auto plan. Default is disabled") + cmd.Flags().BoolVar(&flags.AutoMerge, "automerge", flags.AutoMerge, "Enable auto merge. Default is disabled") + cmd.Flags().BoolVar(&flags.Parallel, "parallel", flags.Parallel, "Enables plans and applys to happen in parallel. Default is disabled") + cmd.Flags().StringVar(&flags.Output, "output", flags.Output, "Path of the file where configuration will be generated. Default is stdout") + cmd.Flags().StringVar(&flags.Root, "root", flags.Root, "Path to the root directory of the git repo you want to build config for. Default is current dir") + cmd.Flags().BoolVar(&flags.MultiEnv, "multienv", flags.MultiEnv, "Enable injection of environment specific environment variables to each workflow. Default is disabled") + cmd.Flags().StringVar(&flags.DefaultTerraformVersion, "terraform-version", flags.DefaultTerraformVersion, "Default terraform version to run for Atlantis. Default is determined by the Terraform version constraints.") + cmd.Flags().BoolVar(&flags.UseWorkspaces, "use-workspaces", flags.UseWorkspaces, "Use workspaces for projects. Default is disabled") + + cmd.Flags().VisitAll(func(f *pflag.Flag) { + logger.FromContext(cmd.Context()).Sugar().Debugf("Set flag: %s = %v", f.Name, f.Value) + }) +} + +// toOptions converts the flags provided for usage to Options within the repocfg package +func (flags *Flags) toOptions() repocfg.Options { + return repocfg.Options{ + Automerge: flags.AutoMerge, + Autoplan: flags.AutoPlan, + DefaultTerraformVersion: flags.DefaultTerraformVersion, + MultiEnv: flags.MultiEnv, + Parallel: flags.Parallel, + UseWorkspaces: flags.UseWorkspaces, + } +} + +// NewGenerateCmd creates a new `generate` command, while applying all flags +// with their defaults overlayed by the flags passed in by the caller. +func NewGenerateCmd() (*cobra.Command, error) { + flags, err := NewFlags() + if err != nil { + return nil, fmt.Errorf("new flags: %w", err) + } + + cmd := &cobra.Command{ + Use: "generate", + Short: "Makes Atlantis config for tfvar backed Terraform projects", + Long: "Logs Yaml representing Atlantis config to stderr", + RunE: func(cmd *cobra.Command, args []string) error { + err := generate(cmd, flags) + if err != nil { + return err + } + return nil + }, + } + + flags.AddFlags(cmd) + + return cmd, nil +} + +// generate is used to generate an Atlantis config, called from the `generate` +// command, creating an Atlantis configuration written to flags.OutputPath +func generate(cmd *cobra.Command, flags *Flags) error { + logger := logger.FromContext(cmd.Context()) + + tree, err := discover(cmd.Context(), flags) + if err != nil { + return err + } + + opts := flags.toOptions() + cfg, err := repocfg.NewRepoCfg(tree, opts) + if err != nil { + return err + } + + cfgBytes, err := yaml.Marshal(&cfg) + if err != nil { + return fmt.Errorf("repocfg: %w", err) + } + + switch flags.Output { + case "": + fmt.Println(string(cfgBytes)) + default: + logger.Sugar().Debugf("writing config to %s", flags.Output) + err := os.WriteFile(flags.Output, cfgBytes, 0o644) + if err != nil { + return err + } + } + + return nil +} + +const ( + TF_EXT = ".tf" + TFVARS_EXT = ".tfvars" + TFVARS_JSON_EXT = ".tfvars.json" +) + +// discover walks the directory tree and creates a slice of Terraform components +// and their dependencies based on the .tfvars files in the directory and +// subdirectories. +// +// However, if nested directories contain a .tf file, the .tfvars files in the +// subdirectories are ignored, as they are assumed to be part of a different +// parent node (Terraform component). +// +// For example, if the function is invoked at the path defined by the `root` flag: +// +// . +// ├── components +// │ ├── component1 +// │ │ ├── main.tf +// │ │ └── dev.tfvars +// │ └── component2 +// │ ├── extraVars +// │ │ └── stg.tfvars +// │ ├── main.tf +// │ └── dev.tfvars +// +// Then, the resulting slice of components would look like: +// +// Path: "components/component1" +// VarFiles: "components/component1/dev.tfvars" +// +// Path: "components/component2" +// VarFiles: []string{"components/component2/dev.tfvars", "components/component2/extraVars/stg.tfvars"} +func discover(ctx context.Context, flags *Flags) ([]repocfg.Component, error) { + logger := logger.FromContext(ctx) + + var discovered []repocfg.Component + + // Walk the directory tree from the root + err := filepath.Walk(flags.Root, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + + // Each parent should be a path containing a Terraform component + if !info.IsDir() && strings.HasSuffix(info.Name(), TF_EXT) { + logger.Debug(fmt.Sprintf("found .tf file: %s", path)) + + // Add the directory of the Terraform component as the parent + parent, err := filepath.Rel(flags.Root, filepath.Dir(path)) + if err != nil { + return err + } + + // Each edge should be a path containing Terraform variables files + // relative to the Terraform component + err = filepath.Walk(filepath.Dir(path), func(subpath string, subinfo os.FileInfo, suberr error) error { + if suberr != nil { + return suberr + } + + // Filter out Terraform variable files + if !subinfo.IsDir() && (strings.HasSuffix(subinfo.Name(), TFVARS_EXT) || strings.HasSuffix(subinfo.Name(), TFVARS_JSON_EXT)) { + // Ignore nested Terraform variable files that might belong to nested components + if filepath.Dir(subpath) != filepath.Dir(path) && tfExistsInDir(filepath.Dir(subpath)) { + logger.Sugar().Debugf(`ignoring nested %s: %s + which belongs to the component at: %s + not: %s`, filepath.Ext(subpath), subpath, filepath.Dir(subpath), filepath.Dir(path), + ) + + return filepath.SkipDir + } + + logger.Sugar().Debugf("component parent is %s", parent) + found := repocfg.Component{ + Path: parent, + } + + logger.Sugar().Debugf("found %s file: %s", filepath.Ext(subpath), subpath) + child, err := filepath.Rel(flags.Root, subpath) + if err != nil { + return err + } + + // VarFile is a member of this component + logger.Sugar().Debugf("component %s has var file %s", parent, child) + found.VarFiles = append(found.VarFiles, child) + + discovered = append(discovered, found) + } + return err + }) + return filepath.SkipDir + } + return nil + }) + if err != nil { + return nil, err + } + + return discovered, nil +} + +// tfExistsInDir returns true if a directory contains a Terraform file +func tfExistsInDir(dir string) bool { + files, err := filepath.Glob(filepath.Join(dir, "*"+TF_EXT)) + if err != nil { + return false + } + + return len(files) > 0 +} diff --git a/cmd/root.go b/cmd/root.go new file mode 100644 index 0000000..b2c86f6 --- /dev/null +++ b/cmd/root.go @@ -0,0 +1,56 @@ +package cmd + +import ( + "fmt" + + "github.com/3bbbeau/tfvars-atlantis-config/logger" + "github.com/spf13/cobra" + "go.uber.org/zap" +) + +// New returns the new root command for this utility. +// +// It initializes the root command and adds all subcommands. +func New() (*cobra.Command, error) { + cmd := &cobra.Command{ + Use: "tfvars-atlantis-config", + Short: "Generates Atlantis Config for Terraform projects", + Long: `tfvars-atlantis-config is a utility that generates Atlantis configurations for Terraform projects + that use tfvars files per environment.`, + PersistentPreRun: func(cmd *cobra.Command, args []string) { + setLogger(cmd) + }, + Run: func(cmd *cobra.Command, args []string) { + err := cmd.Help() + if err != nil { + logger.FromContext(cmd.Context()).Error("help cmd", zap.Error(err)) + } + }, + } + cmd.PersistentFlags().Bool("debug", false, "Enable debug mode") + + cmd.AddCommand(NewVersionCmd()) + gCmd, err := NewGenerateCmd() + if err != nil { + return nil, fmt.Errorf("creating generate command: %w", err) + } + cmd.AddCommand(gCmd) + + return cmd, nil +} + +// setLogger sets the logger for the command's lifespan, based on the debug flag. +func setLogger(cmd *cobra.Command) { + ctx := cmd.Context() + + debug, err := cmd.Flags().GetBool("debug") + if err != nil || !debug { + z := zap.Must(zap.NewProductionConfig().Build()) + ctx = logger.WithContext(ctx, z) + } else { + z := zap.Must(zap.NewDevelopmentConfig().Build()) + ctx = logger.WithContext(ctx, z) + } + + cmd.SetContext(ctx) +} diff --git a/cmd/version.go b/cmd/version.go new file mode 100644 index 0000000..3732d53 --- /dev/null +++ b/cmd/version.go @@ -0,0 +1,22 @@ +package cmd + +import ( + "github.com/spf13/cobra" +) + +// Build-time version string, overriden by ldflags. +var v string = "devel" + +// NewVersionCmd returns the command for retrieving the version of this utility. +func NewVersionCmd() *cobra.Command { + cmd := &cobra.Command{ + Use: "version", + Short: "Version of terragrunt-atlantis-config", + Long: "Version of terragrunt-atlantis-config", + Run: func(cmd *cobra.Command, args []string) { + cmd.Println(v) + }, + } + + return cmd +} diff --git a/cmd/version_test.go b/cmd/version_test.go new file mode 100644 index 0000000..898b601 --- /dev/null +++ b/cmd/version_test.go @@ -0,0 +1,24 @@ +package cmd + +import ( + "bytes" + "testing" +) + +// Tests the NewVersionCmd function returns the version of the utility. +func Test_NewVersionCmd(t *testing.T) { + t.Parallel() + + got := new(bytes.Buffer) + cmd, _ := New() + cmd.SetArgs([]string{"version"}) + cmd.SetOutput(got) + cmd.Execute() // nolint:errcheck + want := "devel\n" + + if got.String() != want { + t.Errorf(`NewVersionCmd() + got %s + want %v`, got.String(), want) + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..ead9c41 --- /dev/null +++ b/go.mod @@ -0,0 +1,23 @@ +module github.com/3bbbeau/tfvars-atlantis-config + +go 1.22.0 + +require ( + github.com/google/go-cmp v0.6.0 + github.com/hashicorp/go-version v1.6.0 + github.com/runatlantis/atlantis v0.27.1 + github.com/spf13/cobra v1.8.0 + github.com/spf13/pflag v1.0.5 + go.uber.org/zap v1.26.0 + gopkg.in/yaml.v2 v2.4.0 +) + +require ( + github.com/agext/levenshtein v1.2.3 // indirect + github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect + github.com/go-ozzo/ozzo-validation v3.6.0+incompatible // indirect + github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/pkg/errors v0.9.1 // indirect + github.com/rogpeppe/go-internal v1.10.0 // indirect + go.uber.org/multierr v1.11.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..bb5d4bd --- /dev/null +++ b/go.sum @@ -0,0 +1,52 @@ +github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7lmo= +github.com/agext/levenshtein v1.2.3/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= +github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 h1:DklsrG3dyBCFEj5IhUbnKptjxatkF07cF2ak3yi77so= +github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw= +github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= +github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-ozzo/ozzo-validation v3.6.0+incompatible h1:msy24VGS42fKO9K1vLz82/GeYW1cILu7Nuuj1N3BBkE= +github.com/go-ozzo/ozzo-validation v3.6.0+incompatible/go.mod h1:gsEKFIVnabGBt6mXmxK0MoFy+cZoTJY6mu5Ll3LVLBU= +github.com/go-test/deep v1.1.0 h1:WOcxcdHcvdgThNXjw0t76K42FXTU7HpNQWHpA2HHNlg= +github.com/go-test/deep v1.1.0/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4= +github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ= +github.com/hashicorp/go-version v1.6.0 h1:feTTfFNnjP967rlCxM/I9g701jU+RN74YKx2mOkIeek= +github.com/hashicorp/go-version v1.6.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= +github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= +github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw= +github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8= +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.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= +github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ= +github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog= +github.com/runatlantis/atlantis v0.27.1 h1:J1bwKImaLQBTEW6Zz56rRAVZeHvideSRIfHzhj18H7w= +github.com/runatlantis/atlantis v0.27.1/go.mod h1:HoRKWHy/FtxoAJ7ixtJjLLAe/tYnw5Iy/dGfgftPB5w= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= +github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= +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/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +go.uber.org/goleak v1.2.0 h1:xqgm/S+aQvhWFTtR0XK3Jvg7z8kGV8P4X14IzwN3Eqk= +go.uber.org/goleak v1.2.0/go.mod h1:XJYK+MuIchqpmGmUSAzotztawfKvYLUIgg7guXrwVUo= +go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= +go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/zap v1.26.0 h1:sI7k6L95XOKS281NhVKOFCUNIvv9e0w4BF8N3u+tCRo= +go.uber.org/zap v1.26.0/go.mod h1:dtElttAiwGvoJ/vj4IwHBS/gXsEu/pZ50mUIRWuG0so= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/justfile b/justfile new file mode 100644 index 0000000..f42371b --- /dev/null +++ b/justfile @@ -0,0 +1,17 @@ +set dotenv-load := true + +tool-golangci: + @hash golangci-lint > /dev/null 2>&1; if [ $? -ne 0 ]; then \ + GOBIN="$(pwd)/tools/bin" go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest; \ + fi + +lint: tool-golangci + @$(pwd)/tools/bin/golangci-lint run -E gofumpt --timeout 1m + +build: + @go build -ldflags="-X 'github.com/3bbbeau/tfvars-atlantis-config/cmd.v=${VERSION}'" + +test: + @go test -cover ./... + @go clean --testcache + @go test ./... -v diff --git a/logger/logger.go b/logger/logger.go new file mode 100644 index 0000000..e9772a4 --- /dev/null +++ b/logger/logger.go @@ -0,0 +1,29 @@ +package logger + +import ( + "context" + + "go.uber.org/zap" +) + +type loggerKey struct{} + +// WithContext returns a new context with the logger added. +func WithContext(ctx context.Context, l *zap.Logger) context.Context { + return context.WithValue(ctx, loggerKey{}, l) +} + +// FromContext returns the logger in the context if it exists, otherwise a new +// no-op logger is returned . +func FromContext(ctx context.Context) *zap.Logger { + if ctx == nil { + return zap.NewNop() + } + + v := ctx.Value(loggerKey{}) + if v == nil { + return zap.NewNop() + } + + return v.(*zap.Logger) +} diff --git a/main.go b/main.go new file mode 100644 index 0000000..d84b98c --- /dev/null +++ b/main.go @@ -0,0 +1,19 @@ +package main + +import ( + "os" + + "github.com/3bbbeau/tfvars-atlantis-config/cmd" +) + +func main() { + cmd, err := cmd.New() + if err != nil { + os.Exit(1) + } + + err = cmd.Execute() + if err != nil { + os.Exit(1) + } +} diff --git a/repocfg/project.go b/repocfg/project.go new file mode 100644 index 0000000..eab05a3 --- /dev/null +++ b/repocfg/project.go @@ -0,0 +1,105 @@ +package repocfg + +import ( + "fmt" + "path/filepath" + + "github.com/hashicorp/go-version" + "github.com/runatlantis/atlantis/server/core/config/raw" +) + +// ExtRawProject extends the raw.Project type to add additional methods +type ExtRawProject struct { + raw.Project +} + +// ErrProjectFrom represents an error when creating an Atlantis project from a +// Terraform component along with some useful contextual information. +type ErrNewProject struct { + Err error + Component Component + Project *ExtRawProject +} + +// Stringer implementation for ErrProjectFrom +func (e ErrNewProject) Error() string { + return fmt.Sprintf(`failed to create project: + component: %+v, + project: %+v, + error: %s`, e.Component, e.Project, e.Err) +} + +// ProjectsFrom creates an Atlantis project from a Terraform component and +// its associated Terraform variable files. +func ProjectsFrom(c Component, opts Options) ([]ExtRawProject, error) { + var projects []ExtRawProject + + for _, v := range c.VarFiles { + p := ExtRawProject{ + Project: raw.Project{ + Name: ptr(friendlyName(c.Path, v)), + + // The directory of this project relative to the repo root. + Dir: ptr(c.Path), + Workflow: ptr(friendlyName(c.Path, v)), + }, + } + + if opts.UseWorkspaces { + // Terraform workspaces are represented by the Terraform variable file + // names. + // + // Example: + // + // dev.tfvars -> dev + // stg.tfvars.json -> stg + p.Workspace = ptr(pathWithoutExtension(v)) + } + + // Generate a default Terraform version for the project if enabled + if opts.DefaultTerraformVersion != "" { + p.DefaultTerraformVersion(opts.DefaultTerraformVersion) + } + + // Generate autoplan configuration for the project if enabled + if opts.Autoplan { + p.AutoPlan(v) + } + + // We can validate the project using the Atlantis validate method + err := p.Validate() + if err != nil { + return nil, fmt.Errorf("failed to validate project: %w", err) + } + projects = append(projects, p) + } + return projects, nil +} + +// AutoPlan sets the autoplan configuration for the project +// +// This will trigger a plan when the Terraform files or the variable files +// are modified. +func (p *ExtRawProject) AutoPlan(v string) { + autoplan := &raw.Autoplan{ + Enabled: ptr(true), + + // Paths are relative to the project directory + WhenModified: []string{ + "*.tf", + filepath.Base(v), + }, + } + p.Autoplan = autoplan +} + +// DefaultTerraformVersion sets the default Terraform version for the project +// if the version is valid. +func (p *ExtRawProject) DefaultTerraformVersion(v string) { + ver, err := version.NewSemver(v) + if err != nil { + p.TerraformVersion = new(string) + } else { + p.TerraformVersion = ptr(ver.String()) + } +} diff --git a/repocfg/project_test.go b/repocfg/project_test.go new file mode 100644 index 0000000..65bd72b --- /dev/null +++ b/repocfg/project_test.go @@ -0,0 +1,118 @@ +package repocfg + +import ( + "testing" + + "github.com/google/go-cmp/cmp" + "github.com/runatlantis/atlantis/server/core/config/raw" +) + +// Tests the ProjectFrom method for a project +func Test_ProjectsFrom(t *testing.T) { + t.Parallel() + + tests := []struct { + component Component + options Options + want []ExtRawProject + }{ + { + component: Component{ + Path: "test", + VarFiles: []string{"env.tfvars"}, + }, + options: Options{ + Autoplan: true, + DefaultTerraformVersion: "8.8.8", + Parallel: true, + UseWorkspaces: true, + }, + want: []ExtRawProject{ + { + Project: raw.Project{ + Name: ptr("test-env"), + Dir: ptr("test"), + Workflow: ptr("test-env"), + Workspace: ptr("env"), + TerraformVersion: ptr("8.8.8"), + Autoplan: &raw.Autoplan{ + Enabled: ptr(true), + WhenModified: []string{ + "*.tf", + "env.tfvars", + }, + }, + }, + }, + }, + }, + } + + for _, tc := range tests { + got, err := ProjectsFrom(tc.component, tc.options) + if err != nil { + t.Errorf("ProjectFrom() error: %s", err) + } + + if !cmp.Equal(got, tc.want) { + t.Errorf(`ProjectFrom() + diff %s`, cmp.Diff(got, tc.want)) + } + } +} + +// Tests the AutoPlan method for a project +func Test_AutoPlan(t *testing.T) { + t.Parallel() + + want := &raw.Autoplan{ + Enabled: ptr(true), + WhenModified: []string{ + "*.tf", + "env.tfvars", + }, + } + + got := new(ExtRawProject) + + got.AutoPlan("env.tfvars") + + if !cmp.Equal(got.Autoplan, want) { + t.Errorf(`AutoPlan() + diff %s`, cmp.Diff(got, want)) + } +} + +// Tests the DefaultTerraformVersion method for a project +func Test_DefaultTerraformVersion(t *testing.T) { + t.Parallel() + + tests := []struct { + version string + want raw.Project + }{ + { + version: "8.8.8", + want: raw.Project{ + TerraformVersion: ptr("8.8.8"), + }, + }, + { + version: "invalid", + want: raw.Project{ + TerraformVersion: new(string), + }, + }, + } + + for _, tc := range tests { + new := new(ExtRawProject) + new.DefaultTerraformVersion(tc.version) + got := new.Project.TerraformVersion + + if !cmp.Equal(got, tc.want.TerraformVersion) { + t.Errorf(`DefaultTerraformVersion() + diff %s`, cmp.Diff(got, tc.want)) + } + } +} diff --git a/repocfg/repocfg.go b/repocfg/repocfg.go new file mode 100644 index 0000000..b811505 --- /dev/null +++ b/repocfg/repocfg.go @@ -0,0 +1,99 @@ +package repocfg + +import ( + "fmt" + + "github.com/runatlantis/atlantis/server/core/config/raw" + "gopkg.in/yaml.v2" +) + +var ErrNoExistingConfig = fmt.Errorf("no existing config found") + +// Options represents the top-level configuration for a new Atlantis RepoCfg +type Options struct { + Automerge bool + Autoplan bool + DefaultTerraformVersion string + Parallel bool + MultiEnv bool + UseWorkspaces bool +} + +// Component represents a Terraform component and its associated Terraform variable files +type Component struct { + Path string + VarFiles []string +} + +// ExtRawRepoCfg is an embedded type for a raw.RepoCfg +type ExtRawRepoCfg struct { + raw.RepoCfg `yaml:",inline"` +} + +// NewRepoCfg returns a new Atlantis RepoCfg from a slice of components +// and options. +// +// Reference: https://www.runatlantis.io/docs/repo-level-atlantis-yaml.html +func NewRepoCfg(components []Component, opts Options) (*ExtRawRepoCfg, error) { + repoCfg := &ExtRawRepoCfg{ + RepoCfg: raw.RepoCfg{ + Version: ptr(3), + Automerge: &opts.Automerge, + ParallelPlan: &opts.Parallel, + ParallelApply: &opts.Parallel, + }, + } + + var projects []raw.Project + for _, c := range components { + generated, err := ProjectsFrom(c, opts) + if err != nil { + return nil, fmt.Errorf("failed while creating projects with component %+v: %w", c, err) + } + + for _, p := range generated { + projects = append(projects, p.Project) + } + } + + repoCfg.Projects = append(repoCfg.Projects, projects...) + + workflows := map[string]raw.Workflow{} + for _, c := range components { + generated, err := WorkflowsFrom(c, opts) + if err != nil { + return nil, fmt.Errorf("failed while creating workflows with component %+v: %w", c, err) + } + for _, wf := range generated { + workflows[wf.Name] = wf.Workflow + } + } + + repoCfg.Workflows = workflows + + return repoCfg, nil +} + +func (rc *ExtRawRepoCfg) MarshalYAML() (interface{}, error) { + m := yaml.MapSlice{ + {Key: "version", Value: rc.Version}, + {Key: "automerge", Value: rc.Automerge}, + {Key: "parallel_plan", Value: rc.ParallelPlan}, + {Key: "parallel_apply", Value: rc.ParallelApply}, + {Key: "projects", Value: rc.Projects}, + } + + workflows := yaml.MapSlice{} + for name, wf := range rc.Workflows { + workflows = append(workflows, yaml.MapItem{ + Key: name, + Value: yaml.MapSlice{ + {Key: "plan", Value: wf.Plan}, + {Key: "apply", Value: wf.Apply}, + }, + }) + } + + m = append(m, yaml.MapItem{Key: "workflows", Value: workflows}) + return m, nil +} diff --git a/repocfg/repocfg_test.go b/repocfg/repocfg_test.go new file mode 100644 index 0000000..5ff92ca --- /dev/null +++ b/repocfg/repocfg_test.go @@ -0,0 +1,100 @@ +package repocfg + +import ( + "testing" + + "github.com/google/go-cmp/cmp" + "github.com/runatlantis/atlantis/server/core/config/raw" +) + +func Test_NewFrom(t *testing.T) { + t.Parallel() + + tests := []struct { + name string + components []Component + want *ExtRawRepoCfg + }{ + { + name: "WithNestedVars", + components: []Component{ + { + Path: "test", + VarFiles: []string{"test/vars/dev.tfvars", "test/vars/nested/stg.tfvars"}, + }, + }, + want: &ExtRawRepoCfg{ + RepoCfg: raw.RepoCfg{ + Version: ptr(3), + Automerge: ptr(false), + ParallelPlan: ptr(false), + ParallelApply: ptr(false), + Workflows: map[string]raw.Workflow{ + "test-dev": { + Plan: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("init"), + }, + { + Map: map[string]map[string][]string{ + "plan": {"extra_args": []string{"-var-file=vars/dev.tfvars"}}, + }, + }, + }, + }, + Apply: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("apply"), + }, + }, + }, + }, + "test-stg": { + Plan: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("init"), + }, + { + Map: map[string]map[string][]string{ + "plan": {"extra_args": []string{"-var-file=vars/nested/stg.tfvars"}}, + }, + }, + }, + }, + Apply: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("apply"), + }, + }, + }, + }, + }, + Projects: []raw.Project{ + { + Name: ptr("test-dev"), + Dir: ptr("test"), + Workflow: ptr("test-dev"), + }, + { + Name: ptr("test-stg"), + Dir: ptr("test"), + Workflow: ptr("test-stg"), + }, + }, + }, + }, + }, + } + + for _, tc := range tests { + got, _ := NewRepoCfg(tc.components, Options{}) + if !cmp.Equal(got, tc.want) { + t.Errorf(`NewFrom() + diff %s`, cmp.Diff(got, tc.want)) + } + } +} diff --git a/repocfg/util.go b/repocfg/util.go new file mode 100644 index 0000000..d6814ee --- /dev/null +++ b/repocfg/util.go @@ -0,0 +1,68 @@ +package repocfg + +import ( + "fmt" + "os" + "path/filepath" + "strings" +) + +// Ptr returns a pointer to type T +func ptr[T any](v T) *T { return &v } + +// friendlyName creates a contextual name used for Atlantis projects and workflows +func friendlyName(path, environment string) string { + name := []string{strings.ReplaceAll(path, "/", "-"), pathWithoutExtension(filepath.Base(environment))} + return strings.TrimSuffix(strings.Join(name, "-"), "-") +} + +// pathWithoutExtension removes the file extension from a base path. +// if the path has no extension ("."), it returns an empty string. +func pathWithoutExtension(path string) string { + return strings.TrimSuffix(strings.TrimSuffix(filepath.Base(path), filepath.Ext(path)), filepath.Base(path)) +} + +var ErrNoEnvVars error = fmt.Errorf("no matching prefixed environment variables found") + +// Generates the Atlantis multienv string within stages for multi-environment +// Terraform projects, e.g: +// +// EnvVar1Name=value1,EnvVar2Name=value2,EnvVar3Name=value3 +// +// Given a prefix for the environment name of the workflow, strips the +// environment name from existing environment vars while keeping their value. +// +// This is useful when you want to configure providers via environment variables +// on a per-environment basis. +// +// Example: +// +// DEV_AWS_ACCESS_KEY_ID="foo" +// DEV_AWS_SECRET_ACCESS_KEY="bar" +// -> +// AWS_ACCESS_KEY_ID=$DEV_AWS_ACCESS_KEY_ID +// AWS_SECRET_ACCESS_KEY=$DEV_AWS_SECRET_ACCESS_KEY +func prefixedEnviron(prefix string) (*string, error) { + prefix = strings.ToUpper(prefix) + if !strings.HasSuffix(prefix, "_") { + prefix += "_" + } + + strippedEnviron := []string{} + for _, v := range os.Environ() { + if strings.HasPrefix(v, prefix) { + // Limits the split to only two parts, separating the key from the first + // occurrence of '=', otherwise if the value contains '=' character(s) the + // string would be split into more than two parts. + name := strings.SplitN(v, "=", 2)[0] + + // Strips the prefix from the environment variable name, e.g. "DEV_" from + // "DEV_AWS_ACCESS_KEY_ID" and let it equal to the original environment variable + strippedEnviron = append(strippedEnviron, fmt.Sprintf("%s=$%s", strings.TrimPrefix(name, prefix), name)) + } + } + if len(strippedEnviron) == 0 { + return nil, ErrNoEnvVars + } + return ptr(fmt.Sprintf("echo %s", strings.Join(strippedEnviron, ","))), nil +} diff --git a/repocfg/util_test.go b/repocfg/util_test.go new file mode 100644 index 0000000..a64450d --- /dev/null +++ b/repocfg/util_test.go @@ -0,0 +1,73 @@ +package repocfg + +import ( + "testing" + + "github.com/google/go-cmp/cmp" +) + +// Tests the ptr helper function. Given a generic value it should return a +// pointer to that value. +func Test_Ptr(t *testing.T) { + t.Parallel() + + intV := 3 + strV := "test" + boolV := true + + for _, T := range []any{intV, strV, boolV} { + got := ptr(T) + if *got != T { + t.Errorf(`ptr() + got %v + want %v + diff %s`, got, T, cmp.Diff(got, T)) + } + } +} + +// Tests the friendlyName helper function. Given a path and an environment it +// should provide a contextual name to be used for Atlantis projects and workflows. +func Test_FriendlyName(t *testing.T) { + t.Parallel() + + path := "my/path/to/some/terraform/component" + environment := "my/path/to/some/terraform/component/dev.tfvars" + + want := "my-path-to-some-terraform-component-dev" + got := friendlyName(path, environment) + if got != want { + t.Errorf(`friendlyName() + got %v + want %v + diff %s`, got, want, cmp.Diff(got, want)) + } +} + +func Test_PathWithoutExtension(t *testing.T) { + t.Parallel() + + tests := []struct { + path string + want string + }{ + { + path: "dev.tfvars", + want: "dev", + }, + { + path: "dev", + want: "", + }, + } + + for _, tc := range tests { + got := pathWithoutExtension(tc.path) + if got != tc.want { + t.Errorf(`pathWithoutExtension() + got %v + want %v + diff %s`, got, tc.want, cmp.Diff(got, tc.want)) + } + } +} diff --git a/repocfg/workflow.go b/repocfg/workflow.go new file mode 100644 index 0000000..543213f --- /dev/null +++ b/repocfg/workflow.go @@ -0,0 +1,175 @@ +package repocfg + +import ( + "errors" + "fmt" + "path/filepath" + + "github.com/runatlantis/atlantis/server/core/config/raw" +) + +// ExtRawWorkflow extends the raw.Workflow type to add additional methods +// and fields +type ExtRawWorkflow struct { + Name string + Args *ExtraArgs + Workspace string + raw.Workflow +} + +// ExtraArgs is a type aliased map of extra arguments to be passed within a workflow +type ExtraArgs map[string][]string + +// hasArgs returns true if the component has a target (i.e. a Terraform variable file) +func hasArgs(c Component) bool { + return len(c.VarFiles) > 0 +} + +// Add generates the extra_args for the stage and adds them to the stage's Args +func (args *ExtraArgs) Add(v []string) { + (*args)["extra_args"] = v +} + +// relativeVarFile returns the path of the variable file v relative to +// the component's path. +func relativeVarFile(c, v string) (*string, error) { + absComponent, err := filepath.Abs(c) + if err != nil { + return nil, fmt.Errorf("absolute path for component %s: %s", c, err) + } + + absVarFile, err := filepath.Abs(v) + if err != nil { + return nil, fmt.Errorf("absolute path for %s: %s", v, err) + } + + rel, err := filepath.Rel(absComponent, absVarFile) + if err != nil { + return nil, fmt.Errorf("relative path for %s: %s", v, err) + } + return &rel, nil +} + +// WorkflowsFrom creates new Atlantis workflows from a Terraform component +// and calls the stage methods to generate all of its fields. +func WorkflowsFrom(c Component, opts Options) ([]ExtRawWorkflow, error) { + var workflows []ExtRawWorkflow + for _, v := range c.VarFiles { + + wf := ExtRawWorkflow{ + Name: friendlyName(c.Path, v), + Workflow: raw.Workflow{ + Plan: &raw.Stage{}, + Apply: &raw.Stage{}, + }, + Args: &ExtraArgs{}, + Workspace: pathWithoutExtension(v), + } + + if hasArgs(c) { + rel, err := relativeVarFile(c.Path, v) + if err != nil { + return nil, fmt.Errorf("relative variable file for %s: %s", v, err) + } + + wf.Args.Add([]string{"-var-file=" + *rel}) + } + + if opts.MultiEnv { + err := wf.AddMultiEnv(v) + if err != nil { + return nil, fmt.Errorf("adding multienv for %s: %s", v, err) + } + } + + if opts.UseWorkspaces { + wf.AddWorkspace() + } + + wf.PlanStage(opts) + wf.ApplyStage(opts) + + err := wf.Validate() + if err != nil { + return nil, fmt.Errorf("workflow validation failed for %s: %s", wf.Name, err) + } + workflows = append(workflows, wf) + } + return workflows, nil +} + +// PlanStage generates the plan stage for the workflow +func (wf *ExtRawWorkflow) PlanStage(opts Options) { + if wf.Plan == nil { + wf.Plan = new(raw.Stage) + } + + init := raw.Step{ + Key: ptr("init"), + } + wf.Plan.Steps = append(wf.Plan.Steps, init) + + if len(*wf.Args) > 0 { + wf.Plan.Steps = append(wf.Plan.Steps, raw.Step{ + Map: map[string]map[string][]string{ + "plan": *wf.Args, + }, + }) + } else { + wf.Plan.Steps = append(wf.Plan.Steps, raw.Step{ + Key: ptr("plan"), + }) + } +} + +// ApplyStage generates the apply stage for the workflow +// +// Unlike the plan stage, the apply stage doesn't need extra args for -var-file, +// as it uses the planfile generated by the plan stage. +func (wf *ExtRawWorkflow) ApplyStage(opts Options) { + if wf.Apply == nil { + wf.Apply = new(raw.Stage) + } + + wf.Apply.Steps = append(wf.Apply.Steps, raw.Step{ + Key: ptr("apply"), + }) +} + +// AddWorkspace sets TF_WORKSPACE in the plan and apply stages +// to the value of the workspace from the project configuration. +// +// This is needed because Atlantis will use the default workspace +// which doesn't exist. +func (wf *ExtRawWorkflow) AddWorkspace() { + for _, stg := range []*raw.Stage{wf.Plan, wf.Apply} { + stg.Steps = append(stg.Steps, raw.Step{ + EnvOrRun: map[string]map[string]string{ + "env": { + "name": "TF_WORKSPACE", + "value": wf.Workspace, + }, + }, + }) + } +} + +// AddMultiEnv adds the multienv step to the plan and apply stages +func (wf *ExtRawWorkflow) AddMultiEnv(env string) error { + environ, err := prefixedEnviron(pathWithoutExtension(env)) + if errors.Is(err, ErrNoEnvVars) { + return nil + } + if err != nil { + return fmt.Errorf("adding multienv for environment %s: %w", env, err) + } + + for _, stg := range []*raw.Stage{wf.Plan, wf.Apply} { + stg.Steps = append(stg.Steps, raw.Step{ + StringVal: map[string]string{ + "multienv": *environ, + }, + }) + } + return nil +} diff --git a/repocfg/workflow_test.go b/repocfg/workflow_test.go new file mode 100644 index 0000000..140d8c6 --- /dev/null +++ b/repocfg/workflow_test.go @@ -0,0 +1,96 @@ +package repocfg + +import ( + "testing" + + "github.com/google/go-cmp/cmp" + "github.com/runatlantis/atlantis/server/core/config/raw" +) + +// Tests creating a new workflow from a Terraform component +func Test_WorkflowsFrom(t *testing.T) { + t.Parallel() + + tests := []struct { + name string + component Component + want []ExtRawWorkflow + }{ + { + name: "new-workflow", + component: Component{ + Path: "test", + VarFiles: []string{"test/vars/dev.tfvars", "test/vars/stg.tfvars"}, + }, + want: []ExtRawWorkflow{ + { + Name: "test-dev", + Args: &ExtraArgs{ + "extra_args": []string{"-var-file=vars/dev.tfvars"}, + }, + Workspace: "dev", + Workflow: raw.Workflow{ + Plan: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("init"), + }, + { + Map: map[string]map[string][]string{ + "plan": {"extra_args": []string{"-var-file=vars/dev.tfvars"}}, + }, + }, + }, + }, + Apply: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("apply"), + }, + }, + }, + }, + }, + { + Name: "test-stg", + Args: &ExtraArgs{ + "extra_args": []string{"-var-file=vars/stg.tfvars"}, + }, + Workspace: "stg", + Workflow: raw.Workflow{ + Plan: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("init"), + }, + { + Map: map[string]map[string][]string{ + "plan": {"extra_args": []string{"-var-file=vars/stg.tfvars"}}, + }, + }, + }, + }, + Apply: &raw.Stage{ + Steps: []raw.Step{ + { + Key: ptr("apply"), + }, + }, + }, + }, + }, + }, + }, + } + + for _, tc := range tests { + got, err := WorkflowsFrom(tc.component, Options{}) + if err != nil { + t.Errorf("WorkflowsFrom(): %s", err) + } + if !cmp.Equal(got, tc.want) { + t.Errorf(`WorkflowFrom() + diff %s`, cmp.Diff(got, tc.want)) + } + } +}