diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,677 @@ +Original Linter and Parser licensed under the GPLv3 license. All substantial +modifications are released under this license. + + 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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +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: + + {project} Copyright (C) {year} {fullname} + 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 --- /dev/null +++ b/README.md @@ -0,0 +1,113 @@ +# haskell-language-docker +[Hackage](https://hackage.haskell.org/package/language-docker) + +- - - +Dockerfile parser, pretty-printer and embedded DSL + +Provides de ability to parse docker files, a pretty-printer and EDSL for writting Dockerfiles in +Haskell. + +- [Parsing files](#parsing-files) +- [Parsing strings](#parsing-strings) +- [Pretty-printing files](#pretty-printing-files) +- [Writing Dockerfiles in Haskell](#writing-dockerfiles-in-haskell) +- [Using the QuasiQuoter](#using-the-quasiquoter) +- [Templating Dockerfiles in Haskell](#templating-dockerfiles-in-haskell) +- [Using IO in the DSL](#using-io-in-the-dsl) + +## Parsing files +```haskell +import Language.Docker +main = do + ef <- parseFile "./Dockerfile" + print ef +``` + +## Parsing strings +```haskell +import Language.Docker +main = do + c <- readFile "./Dockerfile" + print (parseString c) +``` + +## Pretty-printing files +```haskell +import Language.Docker +main = do + Right d <- parseFile "./Dockerfile" + putStr (prettyPrint d) +``` + +## Writing Dockerfiles in Haskell +```haskell +{-# LANGUAGE OverloadedStrings #-} +import Language.Docker +main = putStr $ toDockerfileStr $ do + from "node" + run "apt-get update" + runArgs ["apt-get", "install", "something"] + -- ... +``` + +## Using the QuasiQuoter +```haskell +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} +import Language.Docker +main = putStr $ toDockerfileStr $ do + from "node" + run "apt-get update" + [edockerfile| + RUN apt-get update + CMD node something.js + |] + -- ... +``` + +## Templating Dockerfiles in Haskell +```haskell +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE OverloadedStrings #-} +import Control.Monad +import Language.Docker +tags = ["7.8", "7.10", "8"] +cabalSandboxBuild packageName = do + let cabalFile = packageName ++ ".cabal" + run "cabal sandbox init" + run "cabal update" + add cabalFile ("/app/" ++ cabalFile) + run "cabal install --only-dep -j" + add "." "/app/" + run "cabal build" +main = + forM_ tags $ \tag -> do + let df = toDockerfileStr $ do + from ("haskell" `tagged` tag) + cabalSandboxBuild "mypackage" + writeFile ("./examples/templating-" ++ tag ++ ".dockerfile") df +``` + +## Using IO in the DSL +By default the DSL runs in the `Identity` monad. By running in IO we can +support more features like file globbing: + +```haskell +{-# LANGUAGE OverloadedStrings #-} +import Language.Docker +import qualified System.Directory as Directory +import qualified System.FilePath as FilePath +import qualified System.FilePath.Glob as Glob +main = do + str <- toDockerfileStrIO $ do + fs <- liftIO $ do + cwd <- Directory.getCurrentDirectory + fs <- Glob.glob "./test/*.hs" + return (map (FilePath.makeRelative cwd) fs) + from "ubuntu" + mapM_ (\f -> add f ("/app/" ++ FilePath.takeFileName f)) fs + putStr str +``` + +## License +GPLv3 diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/language-docker.cabal b/language-docker.cabal new file mode 100644 --- /dev/null +++ b/language-docker.cabal @@ -0,0 +1,111 @@ +-- This file has been generated from package.yaml by hpack version 0.17.1. +-- +-- see: https://github.com/sol/hpack + +name: language-docker +version: 1.0.0 +synopsis: Dockerfile parser, pretty-printer and embedded DSL +description: All functions for parsing, printing and writting Dockerfiles are exported through @Language.Docker@. For more fine-grained operations look for specific modules that implement a certain functionality. + See the for the source-code and examples. +category: Development +homepage: https://github.com/hadolint/language-docker#readme +bug-reports: https://github.com/hadolint/language-docker/issues +author: Lukas Martinelli, + Pedro Tacla Yamada, + José Lorenzo Rodríguez +maintainer: me@lukasmartinelli.ch, + lorenzo@seatgeek.com +copyright: Lukas Martinelli, Copyright (c) 2016, + Pedro Tacla Yamada, Copyright (c) 2016, + José Lorenzo Rodríguez, Copyright (c) 2017 +license: GPL-3 +license-file: LICENSE +build-type: Simple +cabal-version: >= 1.10 + +extra-source-files: + README.md + +source-repository head + type: git + location: https://github.com/hadolint/language-docker + +library + hs-source-dirs: + src + ghc-options: -Wall -fno-warn-unused-do-bind -fno-warn-orphans + build-depends: + base >=4.8 && <5 + , bytestring >=0.10 + , parsec >=3.1 + , pretty + , split >=0.2 + , free + , mtl + , transformers + , template-haskell + , th-lift + , th-lift-instances + , text + , yaml + , aeson + , Glob + , unordered-containers + , directory + , filepath + exposed-modules: + Language.Docker + Language.Docker.Parser + Language.Docker.Predef + Language.Docker.PrettyPrint + Language.Docker.Normalize + Language.Docker.Syntax + Language.Docker.Lexer + Language.Docker.Syntax.Lift + Language.Docker.EDSL + Language.Docker.EDSL.Quasi + Language.Docker.EDSL.Types + other-modules: + Language.Docker.EDSL.Plugins + Paths_language_docker + default-language: Haskell2010 + +test-suite hspec + type: exitcode-stdio-1.0 + main-is: Spec.hs + hs-source-dirs: + test + build-depends: + base >=4.8 && <5 + , bytestring >=0.10 + , parsec >=3.1 + , pretty + , split >=0.2 + , free + , mtl + , transformers + , template-haskell + , th-lift + , th-lift-instances + , text + , yaml + , aeson + , Glob + , unordered-containers + , directory + , filepath + , hspec + , QuickCheck + , language-docker + , Glob + , directory + , filepath + , process + , HUnit >=1.2 + other-modules: + Language.Docker.EDSL.PluginsSpec + Language.Docker.EDSL.QuasiSpec + Language.Docker.EDSLSpec + Language.Docker.ExamplesSpec + Language.Docker.ParserSpec + default-language: Haskell2010 diff --git a/src/Language/Docker.hs b/src/Language/Docker.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker.hs @@ -0,0 +1,81 @@ +module Language.Docker + ( Language.Docker.Syntax.Dockerfile -- * Parsing Dockerfiles (@Language.Docker.Syntax@ and @Language.Docker.Parser@) + , parseString + , parseFile + -- * Pretty-printing Dockerfiles (@Language.Docker.PrettyPrint@) + , prettyPrint + , prettyPrintInstructionPos + -- * Writting Dockerfiles (@Language.Docker.EDSL@) + , Language.Docker.EDSL.toDockerfileStr + , Language.Docker.EDSL.toDockerfile + , Language.Docker.EDSL.toDockerfileStrIO + , Language.Docker.EDSL.toDockerfileIO + , Language.Docker.EDSL.runDockerfileIO + , Language.Docker.EDSL.runDockerfileStrIO + , Control.Monad.IO.Class.liftIO + , Language.Docker.EDSL.from + -- ** Constructing base images + , Language.Docker.EDSL.tagged + , Language.Docker.EDSL.untagged + , Language.Docker.EDSL.digested + -- ** Syntax + , Language.Docker.EDSL.add + , Language.Docker.EDSL.user + , Language.Docker.EDSL.label + , Language.Docker.EDSL.stopSignal + , Language.Docker.EDSL.copy + , Language.Docker.EDSL.run + , Language.Docker.EDSL.runArgs + , Language.Docker.EDSL.cmd + , Language.Docker.EDSL.cmdArgs + , Language.Docker.EDSL.workdir + , Language.Docker.EDSL.expose + , Language.Docker.EDSL.ports + , Language.Docker.EDSL.port + , Language.Docker.EDSL.volume + , Language.Docker.EDSL.entrypoint + , Language.Docker.EDSL.entrypointArgs + , Language.Docker.EDSL.maintainer + , Language.Docker.EDSL.env + , Language.Docker.EDSL.arg + , Language.Docker.EDSL.comment + , Language.Docker.EDSL.onBuild + , Language.Docker.EDSL.onBuildRaw + , Language.Docker.EDSL.embed + , Language.Docker.EDSL.Quasi.edockerfile + -- ** Support types for the EDSL + , Language.Docker.EDSL.EDockerfileM + , Language.Docker.EDSL.EDockerfileTM + , Language.Docker.EDSL.Types.EBaseImage(..) + -- * QuasiQuoter (@Language.Docker.EDSL.Quasi@) + , Language.Docker.EDSL.Quasi.dockerfile + -- * Types (@Language.Docker.Syntax@) + , Language.Docker.Syntax.Instruction(..) + , Language.Docker.Syntax.InstructionPos(..) + , Language.Docker.Syntax.BaseImage(..) + , Language.Docker.Syntax.Image + , Language.Docker.Syntax.Tag + , Language.Docker.Syntax.Ports + , Language.Docker.Syntax.Directory + , Language.Docker.Syntax.Source + , Language.Docker.Syntax.Destination + , Language.Docker.Syntax.Arguments + , Language.Docker.Syntax.Pairs + , Language.Docker.Syntax.Filename + , Language.Docker.Syntax.Linenumber + -- * Re-exports from @parsec@ + , ParseError + -- * Instruction and InstructionPos helpers + , Language.Docker.Syntax.instruction + , Language.Docker.EDSL.instructionPos + , Language.Docker.Syntax.sourcename + ) where + +import qualified Control.Monad.IO.Class +import qualified Language.Docker.EDSL +import qualified Language.Docker.EDSL.Quasi +import qualified Language.Docker.EDSL.Types +import Language.Docker.Parser +import Language.Docker.PrettyPrint +import qualified Language.Docker.Syntax +import Text.Parsec (ParseError) diff --git a/src/Language/Docker/EDSL.hs b/src/Language/Docker/EDSL.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/EDSL.hs @@ -0,0 +1,157 @@ +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE TemplateHaskell #-} + +module Language.Docker.EDSL where + +import Control.Monad.Free +import Control.Monad.Free.TH +import Control.Monad.Trans.Free (FreeT, iterTM) +import Control.Monad.Writer +import Data.ByteString (ByteString) + +import qualified Language.Docker.PrettyPrint as PrettyPrint +import qualified Language.Docker.Syntax as Syntax + +import Language.Docker.EDSL.Types + +-- | The type of 'Identity' based EDSL blocks +type EDockerfileM = Free EInstruction + +-- | The type of free monad EDSL blocks +type EDockerfileTM = FreeT EInstruction + +type EInstructionM = Free EInstruction + +type EInstructionTM = FreeT EInstruction + +makeFree ''EInstruction + +runDockerWriter :: (MonadWriter [Syntax.Instruction] m) => EDockerfileM a -> m a +runDockerWriter = iterM runD + +runDockerWriterIO :: + (Monad m, MonadTrans t, Monad (t m), MonadWriter [Syntax.Instruction] (t m), MonadIO (t m)) + => EDockerfileTM m a + -> t m a +runDockerWriterIO = iterTM runD + +runDef :: MonadWriter [t] m => (t1 -> t) -> t1 -> m b -> m b +runDef f a n = tell [f a] >> n + +runDef2 :: MonadWriter [t] m => (t1 -> t2 -> t) -> t1 -> t2 -> m b -> m b +runDef2 f a b n = tell [f a b] >> n + +runD :: MonadWriter [Syntax.Instruction] m => EInstruction (m b) -> m b +runD (From bi n) = + case bi of + EUntaggedImage bi' -> runDef Syntax.From (Syntax.UntaggedImage bi') n + ETaggedImage bi' tg -> runDef Syntax.From (Syntax.TaggedImage bi' tg) n + EDigestedImage bi' d -> runDef Syntax.From (Syntax.DigestedImage bi' d) n +runD (CmdArgs as n) = runDef Syntax.Cmd as n +runD (Shell as n) = runDef Syntax.Shell as n +runD (Add s d n) = runDef2 Syntax.Add s d n +runD (User u n) = runDef Syntax.User u n +runD (Label ps n) = runDef Syntax.Label ps n +runD (StopSignal s n) = runDef Syntax.Stopsignal s n +runD (Copy s d n) = runDef2 Syntax.Copy s d n +runD (RunArgs as n) = runDef Syntax.Run as n +runD (Workdir d n) = runDef Syntax.Workdir d n +runD (Expose ps n) = runDef Syntax.Expose ps n +runD (Volume v n) = runDef Syntax.Volume v n +runD (EntrypointArgs e n) = runDef Syntax.Entrypoint e n +runD (Maintainer m n) = runDef Syntax.Maintainer m n +runD (Env ps n) = runDef Syntax.Env ps n +runD (Arg s n) = runDef Syntax.Arg s n +runD (Comment c n) = runDef Syntax.Comment c n +runD (Healthcheck c n) = runDef Syntax.Healthcheck c n +runD (OnBuildRaw i n) = runDef Syntax.OnBuild i n +runD (Embed is n) = do + tell (map Syntax.instruction is) + n + +instructionPos :: Syntax.Instruction -> Syntax.InstructionPos +instructionPos i = Syntax.InstructionPos i "" 0 + +-- | Runs the Dockerfile EDSL and returns a 'Dockerfile' you can pretty print +-- or manipulate +toDockerfile :: EDockerfileM a -> Syntax.Dockerfile +toDockerfile e = + let (_, w) = runWriter (runDockerWriter e) + in map instructionPos w + +-- | runs the Dockerfile EDSL and returns a 'String' using +-- 'Language.Docker.PrettyPrint' +-- +-- @ +-- import Language.Docker +-- +-- main :: IO () +-- main = writeFile "something.dockerfile" $ toDockerfileStr $ do +-- from (tagged "fpco/stack-build" "lts-6.9") +-- add "." "/app/language-dockerfile" +-- workdir "/app/language-dockerfile" +-- run (words "stack build --test --only-dependencies") +-- cmd (words "stack test") +-- @ +toDockerfileStr :: EDockerfileM a -> String +toDockerfileStr = PrettyPrint.prettyPrint . toDockerfile + +untagged :: String -> EBaseImage +untagged = EUntaggedImage + +tagged :: String -> String -> EBaseImage +tagged = ETaggedImage + +digested :: String -> ByteString -> EBaseImage +digested = EDigestedImage + +ports :: [Integer] -> Syntax.Ports +ports = Syntax.Ports + +port :: Integer -> Syntax.Ports +port = Syntax.Ports . (: []) + +run :: MonadFree EInstruction m => String -> m () +run = runArgs . words + +entrypoint :: MonadFree EInstruction m => String -> m () +entrypoint = entrypointArgs . words + +cmd :: MonadFree EInstruction m => String -> m () +cmd = cmdArgs . words + +-- | ONBUILD Dockerfile instruction +-- +-- Each nested instruction gets emitted as a separate @ONBUILD@ block +-- +-- @ +-- 'toDockerfile' $ do +-- from "node" +-- run "apt-get update" +-- onBuild $ do +-- run "echo more-stuff" +-- run "echo here" +-- @ +onBuild :: MonadFree EInstruction m => EDockerfileM a -> m () +onBuild b = mapM_ (onBuildRaw . Syntax.instruction) (toDockerfile b) + +-- | A version of 'toDockerfile' which allows IO actions +toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Syntax.Dockerfile +toDockerfileIO e = fmap snd (runDockerfileIO e) + +-- | A version of 'toDockerfileStr' which allows IO actions +toDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m String +toDockerfileStrIO e = fmap snd (runDockerfileStrIO e) + +-- | Just runs the EDSL's writer monad +runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Syntax.Dockerfile) +runDockerfileIO e = do + (r, w) <- runWriterT (runDockerWriterIO e) + return (r, map instructionPos w) + +-- | Runs the EDSL's writer monad and pretty-prints the result +runDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m (t, String) +runDockerfileStrIO e = do + (r, w) <- runDockerfileIO e + return (r, PrettyPrint.prettyPrint w) diff --git a/src/Language/Docker/EDSL/Plugins.hs b/src/Language/Docker/EDSL/Plugins.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/EDSL/Plugins.hs @@ -0,0 +1,2 @@ +module Language.Docker.EDSL.Plugins where + diff --git a/src/Language/Docker/EDSL/Quasi.hs b/src/Language/Docker/EDSL/Quasi.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/EDSL/Quasi.hs @@ -0,0 +1,55 @@ +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE TemplateHaskell #-} + +module Language.Docker.EDSL.Quasi where + +import Language.Haskell.TH +import Language.Haskell.TH.Quote +import Language.Haskell.TH.Syntax + +import Language.Docker.EDSL +import qualified Language.Docker.Parser as Parser +import Language.Docker.Syntax +import Language.Docker.Syntax.Lift () + +-- | Quasiquoter for embedding dockerfiles on the EDSL +-- +-- @ +-- putStr $ 'toDockerfile' $ do +-- from "node" +-- run "apt-get update" +-- [edockerfile| +-- RUN apt-get update +-- CMD node something.js +-- |] +-- @ +edockerfile :: QuasiQuoter +edockerfile = dockerfile {quoteExp = edockerfileE} + +edockerfileE :: String -> ExpQ +edockerfileE e = + case Parser.parseString e of + Left err -> fail (show err) + Right d -> + let d' = filterEOL d + in [|embed d'|] + +dockerfile :: QuasiQuoter +dockerfile = + QuasiQuoter + { quoteExp = dockerfileE + , quoteDec = error "Can't use Dockerfile as a declaration" + , quotePat = error "Can't use Dockerfile as a pattern" + , quoteType = error "Can't use Dockerfile as a type" + } + +dockerfileE :: String -> ExpQ +dockerfileE e = + case Parser.parseString e of + Left err -> fail (show err) + Right d -> + let d' = filterEOL d + in lift d' + +filterEOL :: [InstructionPos] -> [InstructionPos] +filterEOL = filter (\(InstructionPos i _ _) -> i /= EOL) diff --git a/src/Language/Docker/EDSL/Types.hs b/src/Language/Docker/EDSL/Types.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/EDSL/Types.hs @@ -0,0 +1,63 @@ +{-# LANGUAGE DeriveFunctor #-} + +module Language.Docker.EDSL.Types where + +import Data.ByteString.Char8 (ByteString) +import Data.String +import qualified Language.Docker.Syntax as Syntax + +data EBaseImage + = EUntaggedImage String + | ETaggedImage String + String + | EDigestedImage String + ByteString + deriving (Show, Eq, Ord) + +instance IsString EBaseImage where + fromString = EUntaggedImage + +data EInstruction next + = From EBaseImage + next + | Add Syntax.Source + Syntax.Destination + next + | User String + next + | Label Syntax.Pairs + next + | StopSignal String + next + | Copy Syntax.Source + Syntax.Destination + next + | RunArgs Syntax.Arguments + next + | CmdArgs Syntax.Arguments + next + | Shell Syntax.Arguments + next + | Workdir Syntax.Directory + next + | Expose Syntax.Ports + next + | Volume String + next + | EntrypointArgs Syntax.Arguments + next + | Maintainer String + next + | Env Syntax.Pairs + next + | Arg String + next + | Comment String + next + | Healthcheck String + next + | OnBuildRaw Syntax.Instruction + next + | Embed [Syntax.InstructionPos] + next + deriving (Functor) diff --git a/src/Language/Docker/Lexer.hs b/src/Language/Docker/Lexer.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/Lexer.hs @@ -0,0 +1,53 @@ +module Language.Docker.Lexer where + +import Text.Parsec.Language (emptyDef) +import Text.Parsec.String (Parser) +import qualified Text.Parsec.Token as Token + +lexer :: Token.TokenParser () +lexer = Token.makeTokenParser style -- style + where + names = + [ "FROM" + , "ADD" + , "RUN" + , "WORKDIR" + , "EXPOSE" + , "VOLUME" + , "ENTRYPOINT" + , "MAINTAINER" + , "ENV" + , "LABEL" + , "USER" + , "SHELL" + , "STOPSIGNAL" + , "CMD" + , "ONBUILD" + , "ARG" + , "HEALTHCHECK" + ] + style = emptyDef {Token.caseSensitive = False, Token.reservedNames = names} + +reserved :: String -> Parser () +reserved = Token.reserved lexer + +reservedOp :: String -> Parser () +reservedOp = Token.reservedOp lexer + +natural :: Parser Integer +natural = Token.natural lexer + +commaSep :: Parser a -> Parser [a] +commaSep = Token.commaSep lexer + +stringLiteral :: Parser String +stringLiteral = Token.stringLiteral lexer + +brackets :: Parser a -> Parser a +brackets = Token.brackets lexer + +identifier :: Parser String +identifier = Token.identifier lexer + +lexeme :: Parser a -> Parser a +lexeme = Token.lexeme lexer diff --git a/src/Language/Docker/Normalize.hs b/src/Language/Docker/Normalize.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/Normalize.hs @@ -0,0 +1,46 @@ +{-# LANGUAGE FlexibleContexts #-} + +module Language.Docker.Normalize + ( normalizeEscapedLines + ) where + +import Data.List (intercalate) +import Data.List.Split (splitOn) + +escapePlaceHolder :: String +escapePlaceHolder = "\\\\" + +escapeSeq :: String +escapeSeq = "\\\n" + +replace :: Eq a => [a] -> [a] -> [a] -> [a] +replace old new = intercalate new . splitOn old + +count :: Eq a => [a] -> [a] -> Int +count s x = length (splitOn x s) - 1 + +trimLines :: String -> String +trimLines s = unlines $ map strip $ lines s + where + strip = lstrip . rstrip + lstrip = dropWhile (`elem` (" \t" :: String)) + rstrip = reverse . lstrip . reverse + +replaceEscapeSigns :: String -> String +replaceEscapeSigns = replace escapeSeq escapePlaceHolder + +removeEscapePlaceholder :: String -> String +removeEscapePlaceholder = replace escapePlaceHolder " " + +compensateLinebreaks :: String -> String +compensateLinebreaks s = concatMap compensate $ lines s + where + compensate line = line ++ "\n" ++ genLinebreaks line + genLinebreaks line = concat $ replicate (count line escapePlaceHolder) "\n" + +-- | Remove new line escapes and join escaped lines together on one line +-- to simplify parsing later on. Escapes are replaced with line breaks +-- to not alter the line numbers. +normalizeEscapedLines :: String -> String +normalizeEscapedLines s = + removeEscapePlaceholder $ compensateLinebreaks $ replaceEscapeSigns $ trimLines s diff --git a/src/Language/Docker/Parser.hs b/src/Language/Docker/Parser.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/Parser.hs @@ -0,0 +1,265 @@ +module Language.Docker.Parser where + +import Control.Monad (void) +import Data.ByteString.Char8 (pack) +import Data.String +import Text.Parsec hiding (label) +import Text.Parsec.String (Parser) +import qualified Text.Parsec.Token as Token + +import Language.Docker.Lexer +import Language.Docker.Normalize +import Language.Docker.Syntax + +comment :: Parser Instruction +comment = do + void $ char '#' + text <- untilEol + return $ Comment text + +taggedImage :: Parser BaseImage +taggedImage = do + name <- untilOccurrence ":\n" + void $ oneOf ":" + tag <- untilEol + return $ TaggedImage name tag + +digestedImage :: Parser BaseImage +digestedImage = do + name <- untilOccurrence "@\n" + void $ oneOf "@" + digest <- untilEol + return $ DigestedImage name (pack digest) + +untaggedImage :: Parser BaseImage +untaggedImage = do + name <- many (noneOf "\n") + return $ UntaggedImage name + +baseImage :: Parser BaseImage +baseImage = try taggedImage <|> try digestedImage <|> try untaggedImage + +from :: Parser Instruction +from = do + reserved "FROM" + image <- baseImage + return $ From image + +cmd :: Parser Instruction +cmd = do + reserved "CMD" + args <- arguments + return $ Cmd args + +copy :: Parser Instruction +copy = do + reserved "COPY" + src <- many (noneOf " ") + Token.whiteSpace lexer + dst <- many (noneOf "\n") + return $ Copy src dst + +shell :: Parser Instruction +shell = do + reserved "SHELL" + args <- arguments + return $ Shell args + +stopsignal :: Parser Instruction +stopsignal = do + reserved "STOPSIGNAL" + args <- many (noneOf "\n") + return $ Stopsignal args + +-- We cannot use string literal because it swallows space +-- and therefore have to implement quoted values by ourselves +quotedValue :: Parser String +quotedValue = do + void $ char '"' + literal <- untilOccurrence "\"" + void $ char '"' + return literal + +rawValue :: Parser String +rawValue = many1 (noneOf [' ', '=', '\n']) + +singleValue :: Parser String +singleValue = try quotedValue <|> try rawValue + +pair :: Parser (String, String) +pair = do + key <- rawValue + void $ oneOf "= " + spaces + value <- singleValue + return (key, value) + +pairs :: Parser Pairs +pairs = do + _ <- many (char ' ') + first <- pair + next <- remainingPairs + return (first : next) + +remainingPairs :: Parser Pairs +remainingPairs = try (char ' ' >> pairs) <|> try (return []) + +label :: Parser Instruction +label = do + reserved "LABEL" + p <- pairs + return $ Label p + +arg :: Parser Instruction +arg = do + reserved "ARG" + p <- untilEol + return $ Arg p + +env :: Parser Instruction +env = do + reserved "ENV" + p <- pairs + return $ Env p + +user :: Parser Instruction +user = do + reserved "USER" + username <- untilEol + return $ User username + +add :: Parser Instruction +add = do + reserved "ADD" + src <- untilOccurrence " " + Token.whiteSpace lexer + dst <- untilOccurrence "\n" + return $ Add src dst + +expose :: Parser Instruction +expose = do + reserved "EXPOSE" + sports <- untilEol + let port = fromString sports + return $ Expose port + +run :: Parser Instruction +run = do + reserved "RUN" + c <- arguments + return $ Run c + +-- Parse value until end of line is reached +untilEol :: Parser String +untilEol = many (noneOf "\n") + +untilOccurrence :: String -> Parser String +untilOccurrence t = many $ noneOf t + +workdir :: Parser Instruction +workdir = do + reserved "WORKDIR" + directory <- many (noneOf "\n") + return $ Workdir directory + +volume :: Parser Instruction +volume = do + reserved "VOLUME" + directory <- many (noneOf "\n") + return $ Volume directory + +maintainer :: Parser Instruction +maintainer = do + reserved "MAINTAINER" + name <- untilEol + return $ Maintainer name + +-- Parse arguments of a command in the exec form +argumentsExec :: Parser Arguments +argumentsExec = brackets $ commaSep stringLiteral + +-- Parse arguments of a command in the shell form +argumentsShell :: Parser Arguments +argumentsShell = do + args <- untilEol + return $ words args + +arguments :: Parser Arguments +arguments = try argumentsExec <|> try argumentsShell + +entrypoint :: Parser Instruction +entrypoint = do + reserved "ENTRYPOINT" + args <- arguments + return $ Entrypoint args + +onbuild :: Parser Instruction +onbuild = do + reserved "ONBUILD" + i <- parseInstruction + return $ OnBuild i + +eolInstruction :: Parser Instruction +eolInstruction = do + eol + return EOL + +healthcheck :: Parser Instruction +healthcheck = do + reserved "HEALTHCHECK" + args <- untilEol + return $ Healthcheck args + +parseInstruction :: Parser Instruction +parseInstruction = + try onbuild <|> -- parse all main instructions + try from <|> + try copy <|> + try run <|> + try workdir <|> + try entrypoint <|> + try volume <|> + try expose <|> + try env <|> + try arg <|> + try user <|> + try label <|> + try stopsignal <|> + try cmd <|> + try shell <|> + try maintainer <|> + try add <|> + try comment <|> + try healthcheck <|> + try eolInstruction + +contents :: Parser a -> Parser a +contents p = do + Token.whiteSpace lexer + r <- p + eof + return r + +eol :: Parser () +eol = void $ char '\n' <|> (char '\r' >> option '\n' (char '\n')) + +dockerfile :: Parser Dockerfile +dockerfile = + many $ + -- deal with empty lines that only contain spaces or tabs + -- skipMany space + -- skipMany $ char '\t' + do + pos <- getPosition + i <- parseInstruction + optional eol + -- skipMany eol + return $ InstructionPos i (sourceName pos) (sourceLine pos) + +parseString :: String -> Either ParseError Dockerfile +parseString s = parse (contents dockerfile) "" $ normalizeEscapedLines s + +parseFile :: String -> IO (Either ParseError Dockerfile) +parseFile file = do + program <- readFile file + return $ parse (contents dockerfile) file $ normalizeEscapedLines program diff --git a/src/Language/Docker/Predef.hs b/src/Language/Docker/Predef.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/Predef.hs @@ -0,0 +1,100 @@ +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverloadedStrings #-} + +module Language.Docker.Predef where + +import Control.Monad +import Control.Monad.Free.Class +import Control.Monad.IO.Class +import Data.Aeson (Value(..)) +import qualified Data.HashMap.Strict as HashMap +import Data.Maybe +import Data.Monoid +import Data.Text (Text) +import qualified Data.Text as Text +import qualified Data.Text.IO as Text +import qualified Data.Yaml as Yaml +import System.Directory +import System.FilePath +import qualified System.FilePath.Glob as Glob + +import Language.Docker +import Language.Docker.EDSL.Types + +appendLnIfMissing :: FilePath -> Text -> IO () +appendLnIfMissing fp cts = do + e <- doesFileExist fp + unless e (Text.writeFile fp "") + txt <- Text.lines <$> Text.readFile fp + unless (cts `elem` txt) $ Text.writeFile fp (Text.unlines (txt <> [cts])) + +dockerIgnore :: Text -> IO () +dockerIgnore = appendLnIfMissing ".dockerignore" + +addGlob :: (MonadIO m, MonadFree EInstruction m) => String -> Destination -> m () +addGlob pattern dest = do + fs <- + liftIO $ do + fs <- Glob.glob pattern + cwd <- getCurrentDirectory + let fs' = map (makeRelative cwd . normalise) fs + forM fs' $ \f -> do + isdir <- doesDirectoryExist f + return $ + if isdir + then (f <> "/", dest <> takeBaseName f) + else (f, dest <> takeBaseName f) + forM_ fs (uncurry add) + +copyGlob :: (MonadIO m, MonadFree EInstruction m) => String -> Destination -> m () +copyGlob = addGlob + +stackBuild :: (Monad m, MonadIO m, MonadFree EInstruction m) => m () +stackBuild = do + sts <- liftIO getStackYamlResolver + stackBuild' sts (return ()) + where + getStackYamlResolver = do + mhm <- Yaml.decodeFile "./stack.yaml" :: IO (Maybe Value) + return $ + fromMaybe "latest" $ do + hm <- mhm + o <- + case hm of + Object o -> return o + _ -> Nothing + rs <- HashMap.lookup "resolver" o + toString rs + where + toString (String m) = Just (Text.unpack m) + toString _ = Nothing + +stackBuild' :: (Monad m, MonadIO m, MonadFree EInstruction m) => String -> m () -> m () +stackBuild' tag extra = do + liftIO $ dockerIgnore ".stack-work" + liftIO $ dockerIgnore ".cabal-sandbox" + from ("fpco" `tagged` tag) + extra + add "./package.yaml" "/app/package.yaml" + addGlob "./*.cabal" "/app/" + add "./stack.yaml" "/app/stack.yaml" + workdir "/app/" + run "stack build --only-dependencies" + add "." "/app/stack.yaml" + run "stack build" + +nodejs :: (Monad m, MonadIO m, MonadFree EInstruction m) => m () +nodejs = nodejs' "6" (return ()) + +nodejs' :: (Monad m, MonadIO m, MonadFree EInstruction m) => String -> m () -> m () +nodejs' tag extra = do + liftIO $ dockerIgnore "node_modules" + liftIO $ dockerIgnore "bower_components" + from ("node" `tagged` tag) + extra + add "./package.json" "/app/package.json" + workdir "/app/" + run "npm install" + add "." "/app/" + cmd "npm start" diff --git a/src/Language/Docker/PrettyPrint.hs b/src/Language/Docker/PrettyPrint.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/PrettyPrint.hs @@ -0,0 +1,124 @@ +{-# LANGUAGE NoMonomorphismRestriction #-} +{-# LANGUAGE RebindableSyntax #-} + +module Language.Docker.PrettyPrint where + +import qualified Data.ByteString.Char8 as ByteString (unpack) +import Data.List (intersperse) +import Data.String +import Language.Docker.Syntax +import Prelude hiding ((>>), (>>=), return) +import Text.PrettyPrint + +-- | Pretty print a 'Dockerfile' to a 'String' +prettyPrint :: Dockerfile -> String +prettyPrint = + unlines . + reverse . + snd . foldl removeDoubleBlank (False, []) . lines . unlines . map prettyPrintInstructionPos + where + removeDoubleBlank (True, m) "" = (True, m) + removeDoubleBlank (False, m) "" = (True, "" : m) + removeDoubleBlank (_, m) s = (False, s : m) + +-- | Pretty print a 'InstructionPos' to a 'String' +prettyPrintInstructionPos :: InstructionPos -> String +prettyPrintInstructionPos (InstructionPos i _ _) = render (prettyPrintInstruction i) + +prettyPrintBaseImage :: BaseImage -> Doc +prettyPrintBaseImage b = + case b of + DigestedImage name digest -> do + text name + char '@' + text (ByteString.unpack digest) + UntaggedImage name -> text name + TaggedImage name tag -> do + text name + char ':' + text tag + where + (>>) = (<>) + return = (mempty <>) + +prettyPrintPairs :: Pairs -> Doc +prettyPrintPairs ps = hsep $ map prettyPrintPair ps + +prettyPrintPair :: (String, String) -> Doc +prettyPrintPair (k, v) = text k <> char '=' <> text (show v) + +prettyPrintArguments :: Arguments -> Doc +prettyPrintArguments as = text (unwords (map helper as)) + where + helper "&&" = "\\\n &&" + helper a = a + +prettyPrintJSON :: Arguments -> Doc +prettyPrintJSON as = brackets $ hsep $ intersperse comma $ map (doubleQuotes . text) as + +prettyPrintInstruction :: Instruction -> Doc +prettyPrintInstruction i = + case i of + Maintainer m -> do + text "MAINTAINER" + text m + Arg a -> do + text "ARG" + text a + Entrypoint e -> do + text "ENTRYPOINT" + prettyPrintArguments e + Stopsignal s -> do + text "STOPSIGNAL" + text s + Workdir w -> do + text "WORKDIR" + text w + Expose (Ports ps) -> do + text "EXPOSE" + hsep (map (text . show) ps) + Expose (PortStr p) -> do + text "EXPOSE" + text p + Volume dir -> do + text "VOLUME" + text dir + Run c -> do + text "RUN" + prettyPrintArguments c + Copy s d -> hsep [text "COPY", text s, text d] + Cmd c -> do + text "CMD" + prettyPrintArguments c + Label l -> do + text "LABEL" + prettyPrintPairs l + Env ps -> do + text "ENV" + prettyPrintPairs ps + User u -> do + text "USER" + text u + Comment s -> do + char '#' + text s + OnBuild i' -> do + text "ONBUILD" + prettyPrintInstruction i' + From b -> do + text "FROM" + prettyPrintBaseImage b + Add s d -> do + text "ADD" + text s + text d + Shell args -> do + text "SHELL" + prettyPrintJSON args + Healthcheck c -> do + text "HEALTHCHECK" + text c + EOL -> mempty + where + (>>) = (<+>) + return = (mempty <>) diff --git a/src/Language/Docker/Syntax.hs b/src/Language/Docker/Syntax.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/Syntax.hs @@ -0,0 +1,90 @@ +module Language.Docker.Syntax where + +import Data.ByteString.Char8 (ByteString) +import Data.Maybe +import Data.String +import Text.Read + +type Image = String + +type Tag = String + +data Ports + = Ports [Integer] + | PortStr String + deriving (Show, Eq, Ord) + +instance IsString Ports where + fromString p = + case readMaybe p of + Just i -> Ports [i] + Nothing -> + let rs = map readMaybe (words p) + in if all isJust rs + then Ports (catMaybes rs) + else PortStr p + +type Directory = String + +data BaseImage + = UntaggedImage Image + | TaggedImage Image + Tag + | DigestedImage Image + ByteString + deriving (Eq, Ord, Show) + +-- | Type of the Dockerfile AST +type Dockerfile = [InstructionPos] + +type Source = String + +type Destination = String + +type Arguments = [String] + +type Pairs = [(String, String)] + +-- | All commands available in Dockerfiles +data Instruction + = From BaseImage + | Add Source + Destination + | User String + | Label Pairs + | Stopsignal String + | Copy Source + Destination + | Run Arguments + | Cmd Arguments + | Shell Arguments + | Workdir Directory + | Expose Ports + | Volume String + | Entrypoint Arguments + | Maintainer String + | Env Pairs + | Arg String + | Healthcheck String + | Comment String + | OnBuild Instruction + | EOL + deriving (Eq, Ord, Show) + +type Filename = String + +type Linenumber = Int + +-- | 'Instruction' with additional location information required for creating +-- good check messages +data InstructionPos = + InstructionPos Instruction + Filename + Linenumber + deriving (Eq, Ord, Show) + +instruction :: InstructionPos -> Instruction +instruction (InstructionPos i _ _) = i + +sourcename :: InstructionPos -> Filename +sourcename (InstructionPos _ fn _) = fn diff --git a/src/Language/Docker/Syntax/Lift.hs b/src/Language/Docker/Syntax/Lift.hs new file mode 100644 --- /dev/null +++ b/src/Language/Docker/Syntax/Lift.hs @@ -0,0 +1,17 @@ +{-# LANGUAGE TemplateHaskell #-} + +module Language.Docker.Syntax.Lift where + +import Instances.TH.Lift () +import Language.Haskell.TH.Lift +import Language.Haskell.TH.Syntax () + +import Language.Docker.Syntax + +deriveLift ''Ports + +deriveLift ''BaseImage + +deriveLift ''Instruction + +deriveLift ''InstructionPos diff --git a/test/Language/Docker/EDSL/PluginsSpec.hs b/test/Language/Docker/EDSL/PluginsSpec.hs new file mode 100644 --- /dev/null +++ b/test/Language/Docker/EDSL/PluginsSpec.hs @@ -0,0 +1,19 @@ +module Language.Docker.EDSL.PluginsSpec + where + +-- import Language.Docker.EDSL +-- import Language.Docker.EDSL.Plugins +import Test.Hspec + +spec = + describe "listPlugins" $ + it "lists docker images matching language-dockerfile-*" pending + -- str <- toDockerFileStrIO $ do + -- ds <- liftIO (glob "./test/*.hs") + -- from "ubuntu" + -- mapM_ add ds + -- str `shouldBe` unlines [ "FROM ubuntu" + -- , "ADD Spec.hs" + -- , "ADD SanitySpec.hs" + -- , "ADD Test.hs" + -- ] diff --git a/test/Language/Docker/EDSL/QuasiSpec.hs b/test/Language/Docker/EDSL/QuasiSpec.hs new file mode 100644 --- /dev/null +++ b/test/Language/Docker/EDSL/QuasiSpec.hs @@ -0,0 +1,39 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} +module Language.Docker.EDSL.QuasiSpec + where + +import Language.Docker.EDSL +import Language.Docker.EDSL.Quasi +import Language.Docker.Syntax +import Test.Hspec + +spec :: Spec +spec = do + describe "dockerfile" $ + it "parses a dockerfile and returns its ast" $ do + let df = map instruction [dockerfile| + FROM node + RUN apt-get update + CMD node something.js + |] + df `shouldBe` [ From (UntaggedImage "node") + , Run ["apt-get", "update"] + , Cmd ["node", "something.js"] + ] + + describe "edockerfile" $ + it "lets us use parsed dockerfiles seamlessly in our DSL" $ do + let d = do + from "node" + expose "8080" + [edockerfile| + RUN apt-get update + CMD node something.js + |] + df = map instruction (toDockerfile d) + df `shouldBe` [ From (UntaggedImage "node") + , Expose (Ports [8080]) + , Run ["apt-get", "update"] + , Cmd ["node", "something.js"] + ] diff --git a/test/Language/Docker/EDSLSpec.hs b/test/Language/Docker/EDSLSpec.hs new file mode 100644 --- /dev/null +++ b/test/Language/Docker/EDSLSpec.hs @@ -0,0 +1,67 @@ +{-# LANGUAGE OverloadedStrings #-} +module Language.Docker.EDSLSpec where + +import Control.Monad.IO.Class +import Data.List (sort) +import Language.Docker.EDSL +import Language.Docker.PrettyPrint +import qualified Language.Docker.Syntax as Syntax +import System.Directory +import System.FilePath +import System.FilePath.Glob +import Test.Hspec + +spec :: Spec +spec = do + describe "toDockerfile s" $ + it "allows us to write haskell code that represents Dockerfiles" $ do + let r = map Syntax.instruction $ toDockerfile (do + from "node" + cmdArgs ["node", "-e", "'console.log(\'hey\')'"]) + r `shouldBe` [ Syntax.From (Syntax.UntaggedImage "node") + , Syntax.Cmd ["node", "-e", "'console.log(\'hey\')'"] + ] + + describe "prettyPrint $ toDockerfile s" $ do + it "allows us to write haskell code that represents Dockerfiles" $ do + let r = prettyPrint $ toDockerfile (do + from "node" + shell ["cmd", "/S"] + cmdArgs ["node", "-e", "'console.log(\'hey\')'"] + healthcheck "--interval=5m CMD curl -f http://localhost/ || exit 1") + r `shouldBe` unlines [ "FROM node" + , "SHELL [\"cmd\" , \"/S\"]" + , "CMD node -e 'console.log(\'hey\')'" + , "HEALTHCHECK --interval=5m CMD curl -f http://localhost/ || exit 1" + ] + + it "onBuild let's us nest statements" $ do + let r = prettyPrint $ toDockerfile $ do + from "node" + cmdArgs ["node", "-e", "'console.log(\'hey\')'"] + onBuild $ do + run "echo \"hello world\"" + run "echo \"hello world2\"" + r `shouldBe` unlines [ "FROM node" + , "CMD node -e 'console.log(\'hey\')'" + , "ONBUILD RUN echo \"hello world\"" + , "ONBUILD RUN echo \"hello world2\"" + ] + + it "onBuild disallows unallowed instructions" pending + + describe "toDockerfileStrIO" $ + it "let's us run in the IO monad" $ do + -- TODO - "glob" is a really useful combinator + str <- toDockerfileStrIO $ do + fs <- liftIO $ do + cwd <- getCurrentDirectory + fs <- glob "./test/Language/Docker/*.hs" + return (map (makeRelative cwd) (sort fs)) + from "ubuntu" + mapM_ (\f -> add f ("/app/" ++ takeFileName f)) fs + str `shouldBe` unlines [ "FROM ubuntu" + , "ADD ./test/Language/Docker/EDSLSpec.hs /app/EDSLSpec.hs" + , "ADD ./test/Language/Docker/ExamplesSpec.hs /app/ExamplesSpec.hs" + , "ADD ./test/Language/Docker/ParserSpec.hs /app/ParserSpec.hs" + ] diff --git a/test/Language/Docker/ExamplesSpec.hs b/test/Language/Docker/ExamplesSpec.hs new file mode 100644 --- /dev/null +++ b/test/Language/Docker/ExamplesSpec.hs @@ -0,0 +1,20 @@ +module Language.Docker.ExamplesSpec where + +import Control.Monad +import Data.Monoid +import System.Directory +import System.FilePath +import System.FilePath.Glob +import System.Process +import Test.Hspec + +stackRunGhc e = callProcess "stack" ["runghc", "--package", "language-dockerfile", e] + +spec :: Spec +spec = do + cwd <- runIO getCurrentDirectory + exampleSources <- runIO $ glob "./examples/*.hs" + forM_ exampleSources $ \exampleSource -> do + let exampleSource' = makeRelative cwd exampleSource + describe exampleSource $ it ("stack runghc " <> exampleSource') $ + stackRunGhc exampleSource diff --git a/test/Language/Docker/ParserSpec.hs b/test/Language/Docker/ParserSpec.hs new file mode 100644 --- /dev/null +++ b/test/Language/Docker/ParserSpec.hs @@ -0,0 +1,154 @@ +module Language.Docker.ParserSpec where + +import Data.List (find) +import Data.Maybe (fromMaybe, isJust) + +import Language.Docker.Normalize +import Language.Docker.Parser +import Language.Docker.Syntax + +import Test.HUnit hiding (Label) +import Test.Hspec +import Text.Parsec + +spec :: Spec +spec = do + describe "parse FROM" $ + it "parse untagged image" $ assertAst "FROM busybox" [From (UntaggedImage "busybox")] + + describe "parse LABEL" $ do + it "parse label" $ assertAst "LABEL foo=bar" [Label[("foo", "bar")]] + it "parses multiline labels" $ + let dockerfile = unlines [ "LABEL foo=bar \\", "hobo=mobo"] + ast = [ Label [("foo", "bar"), ("hobo", "mobo")], EOL ] + in assertAst dockerfile ast + + describe "parse ENV" $ do + it "parses unquoted pair" $ assertAst "ENV foo=bar" [Env [("foo", "bar")]] + it "parse with space between key and value" $ + assertAst "ENV foo bar" [Env [("foo", "bar")]] + it "parse with more then one (white)space between key and value" $ + let dockerfile = "ENV NODE_VERSION \t v5.7.1" + in assertAst dockerfile [Env[("NODE_VERSION", "v5.7.1")]] + it "parse quoted value pair" $ assertAst "ENV foo=\"bar\"" [Env [("foo", "bar")]] + it "parse multiple unquoted pairs" $ + assertAst "ENV foo=bar baz=foo" [Env [("foo", "bar"), ("baz", "foo")]] + it "parse multiple quoted pairs" $ + assertAst "ENV foo=\"bar\" baz=\"foo\"" [Env [("foo", "bar"), ("baz", "foo")]] + it "env works before cmd" $ + let dockerfile = "ENV PATH=\"/root\"\nCMD [\"hadolint\",\"-i\"]" + ast = [Env [("PATH", "/root")], Cmd ["hadolint", "-i"]] + in assertAst dockerfile ast + it "parse with two spaces between" $ + let dockerfile = "ENV NODE_VERSION=v5.7.1 DEBIAN_FRONTEND=noninteractive" + in assertAst dockerfile [Env[("NODE_VERSION", "v5.7.1"), ("DEBIAN_FRONTEND", "noninteractive")]] + it "have envs on multiple lines" $ + let dockerfile = unlines [ "FROM busybox" + , "ENV NODE_VERSION=v5.7.1 \\" + , "DEBIAN_FRONTEND=noninteractive" + ] + ast = [ From (UntaggedImage "busybox") + , Env[("NODE_VERSION", "v5.7.1"), ("DEBIAN_FRONTEND", "noninteractive")] + , EOL + ] + in assertAst dockerfile ast + it "parses long env over multiple lines" $ + let dockerfile = unlines [ "ENV LD_LIBRARY_PATH=\"/usr/lib/\" \\" + , "APACHE_RUN_USER=\"www-data\" APACHE_RUN_GROUP=\"www-data\""] + ast = [Env [("LD_LIBRARY_PATH", "/usr/lib/") + ,("APACHE_RUN_USER", "www-data") + ,("APACHE_RUN_GROUP", "www-data") + ] + , EOL + ] + in assertAst dockerfile ast + + + describe "parse RUN" $ + it "escaped with space before" $ + let dockerfile = unlines ["RUN yum install -y \\ ", "imagemagick \\ ", "mysql"] + in assertAst dockerfile [Run ["yum", "install", "-y", "imagemagick", "mysql"], EOL, EOL] + + describe "parse CMD" $ do + it "one line cmd" $ assertAst "CMD true" [Cmd ["true"]] + it "cmd over several lines" $ + assertAst "CMD true \\\n && true" [Cmd ["true", "&&", "true"], EOL] + it "quoted command params" $ assertAst "CMD [\"echo\", \"1\"]" [Cmd ["echo", "1"]] + + describe "parse SHELL" $ do + it "quoted shell params" $ + assertAst "SHELL [\"/bin/bash\", \"-c\"]" [Shell ["/bin/bash", "-c"]] + + describe "parse HEALTHCHECK" $ + it "parse healthcheck without args" $ + assertAst "HEALTHCHECK --interval=5m \\nCMD curl -f http://localhost/" [Healthcheck "--interval=5m \\nCMD curl -f http://localhost/"] + + describe "parse MAINTAINER" $ do + it "maintainer of untagged scratch image" $ + assertAst + "FROM scratch\nMAINTAINER hudu@mail.com" + [From (UntaggedImage "scratch"), Maintainer "hudu@mail.com"] + it "maintainer with mail" $ + assertAst "MAINTAINER hudu@mail.com" [Maintainer "hudu@mail.com"] + it "maintainer only mail after from" $ + let maintainerFromProg = "FROM busybox\nMAINTAINER hudu@mail.com" + maintainerFromAst = [From (UntaggedImage "busybox"), Maintainer "hudu@mail.com"] + in assertAst maintainerFromProg maintainerFromAst + describe "parse # comment " $ do + it "multiple comments before run" $ + let dockerfile = unlines ["# line 1", "# line 2", "RUN apt-get update"] + in assertAst dockerfile [Comment " line 1", Comment " line 2", Run ["apt-get", "update"], EOL] + it "multiple comments after run" $ + let dockerfile = unlines ["RUN apt-get update", "# line 1", "# line 2"] + in assertAst + dockerfile + [Run ["apt-get", "update"], Comment " line 1", Comment " line 2", EOL] + describe "normalize lines" $ do + it "join multiple ENV" $ + let dockerfile = unlines [ "FROM busybox" + , "ENV NODE_VERSION=v5.7.1 \\" + , "DEBIAN_FRONTEND=noninteractive" + ] + normalizedDockerfile = unlines [ "FROM busybox" + , "ENV NODE_VERSION=v5.7.1 DEBIAN_FRONTEND=noninteractive\n" + ] + in normalizeEscapedLines dockerfile `shouldBe` normalizedDockerfile + it "join escaped lines" $ + let dockerfile = unlines ["ENV foo=bar \\", "baz=foz"] + normalizedDockerfile = unlines ["ENV foo=bar baz=foz", ""] + in normalizeEscapedLines dockerfile `shouldBe` normalizedDockerfile + it "join long CMD" $ + let longEscapedCmd = + unlines + [ "RUN wget https://download.com/${version}.tar.gz -O /tmp/logstash.tar.gz && \\" + , "(cd /tmp && tar zxf logstash.tar.gz && mv logstash-${version} /opt/logstash && \\" + , "rm logstash.tar.gz) && \\" + , "(cd /opt/logstash && \\" + , "/opt/logstash/bin/plugin install contrib)" + ] + longEscapedCmdExpected = + concat + [ "RUN wget https://download.com/${version}.tar.gz -O /tmp/logstash.tar.gz && " + , "(cd /tmp && tar zxf logstash.tar.gz && mv logstash-${version} /opt/logstash && " + , "rm logstash.tar.gz) && " + , "(cd /opt/logstash && " + , "/opt/logstash/bin/plugin install contrib)\n" + , "\n" + , "\n" + , "\n" + , "\n" + ] + in normalizeEscapedLines longEscapedCmd `shouldBe` longEscapedCmdExpected + describe "expose" $ do + it "should handle number ports" $ do + let content = "EXPOSE 8080" + parse expose "" content `shouldBe` Right (Expose (Ports [8080])) + describe "syntax" $ do + it "should handle lowercase instructions (#7 - https://github.com/beijaflor-io/haskell-language-dockerfile/issues/7)" $ do + let content = "from ubuntu" + parse dockerfile "" content `shouldBe` Right [InstructionPos (From (UntaggedImage "ubuntu")) "" 1] + +assertAst s ast = + case parseString (s ++ "\n") of + Left err -> assertFailure $ show err + Right dockerfile -> assertEqual "ASTs are not equal" ast $ map instruction dockerfile diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}