diff --git a/LICENSE b/LICENSE new file mode 100644 --- /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. + + {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,213 @@ +[![Linux/OSX Build Status][travis-img]][travis] +[![Windows Build status][appveyor-img]][appveyor] +[![GPL-3 licensed][license-img]][license] +[![GitHub release][release-img]][release] +[![Github downloads][downloads-img]]() +pipecat + +# Haskell Dockerfile Linter + +A smarter Dockerfile linter that helps you build [best practice][] Docker +images. The linter is parsing the Dockerfile into an AST and performs rules on +top of the AST. It is standing on the shoulders of [ShellCheck][] to lint +the Bash code inside `RUN` instructions. + + + +## How to use + +You can run `hadolint` locally to lint your Dockerfile. + +```bash +hadolint +hadolint --ignore DL3003 --ignore DL3006 # exclude specific rules +``` + +Docker comes to the rescue to provide an easy way how to run `hadolint` on most +platforms. +Just pipe your `Dockerfile` to `docker run`: + +```bash +docker run --rm -i hadolint/hadolint < Dockerfile +``` + +## Install + +You can download prebuilt binaries for OSX, Windows and Linux from the latest +[release page][]. However, if it doesn't work for you, please fall back to +Docker, `brew` or source installation. + +If you are on OSX you can use [brew](http://brew.sh/) to install hadolint. + +```bash +brew install hadolint +``` + +You can also build `hadolint` locally. You need [Haskell][] and the [stack][] +build tool to build the binary. + +```bash +git clone https://github.com/hadolint/hadolint +cd hadolint +stack install +``` + +## Integrations + +To get most of `hadolint` it is useful to integrate it as a check to your CI +or to your editor to lint your `Dockerfile` as you write it. See our +[Integration][] docs. + +## Rules + +An incomplete list of implemented rules. Click on the error code to get more +detailed information. + +- Rules with the prefix `DL` originate from **hadolint**. Take a look at +`Rules.hs` to find the implementation of the rules. + +- Rules with the `SC` prefix originate from **ShellCheck** (Only the most +common rules are listed, there are dozens more) + +Please [create an issue][] if you have an idea for a good rule. + +| Rule | Description | +|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| [DL3000](https://github.com/hadolint/hadolint/wiki/DL3000) | Use absolute WORKDIR. | +| [DL3001](https://github.com/hadolint/hadolint/wiki/DL3001) | For some bash commands it makes no sense running them in a Docker container like ssh, vim, shutdown, service, ps, free, top, kill, mount, ifconfig. | +| [DL3002](https://github.com/hadolint/hadolint/wiki/DL3002) | Do not switch to root USER. | +| [DL3003](https://github.com/hadolint/hadolint/wiki/DL3003) | Use WORKDIR to switch to a directory. | +| [DL3004](https://github.com/hadolint/hadolint/wiki/DL3004) | Do not use sudo as it leads to unpredictable behavior. Use a tool like gosu to enforce root. | +| [DL3005](https://github.com/hadolint/hadolint/wiki/DL3005) | Do not use apt-get upgrade or dist-upgrade. | +| [DL3007](https://github.com/hadolint/hadolint/wiki/DL3007) | Using latest is prone to errors if the image will ever update. Pin the version explicitly to a release tag. | +| [DL3006](https://github.com/hadolint/hadolint/wiki/DL3006) | Always tag the version of an image explicitly. | +| [DL3008](https://github.com/hadolint/hadolint/wiki/DL3008) | Pin versions in apt-get install. | +| [DL3009](https://github.com/hadolint/hadolint/wiki/DL3009) | Delete the apt-get lists after installing something. | +| [DL3010](https://github.com/hadolint/hadolint/wiki/DL3010) | Use ADD for extracting archives into an image. | +| [DL3011](https://github.com/hadolint/hadolint/wiki/DL3011) | Valid UNIX ports range from 0 to 65535. | +| [DL3012](https://github.com/hadolint/hadolint/wiki/DL3012) | Provide an email address or URL as maintainer. | +| [DL3013](https://github.com/hadolint/hadolint/wiki/DL3013) | Pin versions in pip. | +| [DL3014](https://github.com/hadolint/hadolint/wiki/DL3014) | Use the `-y` switch. | +| [DL3015](https://github.com/hadolint/hadolint/wiki/DL3015) | Avoid additional packages by specifying --no-install-recommends. | +| [DL3016](https://github.com/hadolint/hadolint/wiki/DL3016) | Pin versions in `npm`. | +| [DL3017](https://github.com/hadolint/hadolint/wiki/DL3017) | Do not use `apk upgrade`. | +| [DL3018](https://github.com/hadolint/hadolint/wiki/DL3018) | Pin versions in apk add. Instead of `apk add ` use `apk add =`. | +| [DL3019](https://github.com/hadolint/hadolint/wiki/DL3019) | Use the `--no-cache` switch to avoid the need to use `--update` and remove `/var/cache/apk/*` when done installing packages. | +| [DL3020](https://github.com/hadolint/hadolint/wiki/DL3020) | Use `COPY` instead of `ADD` for files and folders. | +| [DL4000](https://github.com/hadolint/hadolint/wiki/DL4000) | MAINTAINER is deprecated. | +| [DL4001](https://github.com/hadolint/hadolint/wiki/DL4001) | Either use Wget or Curl but not both. | +| [DL4003](https://github.com/hadolint/hadolint/wiki/DL4003) | Multiple `CMD` instructions found. | +| [DL4004](https://github.com/hadolint/hadolint/wiki/DL4004) | Multiple `ENTRYPOINT` instructions found. | +| [DL4005](https://github.com/hadolint/hadolint/wiki/DL4005) | Use `SHELL` to change the default shell. | +| [SC1000](https://github.com/koalaman/shellcheck/wiki/SC1000) | `$` is not used specially and should therefore be escaped. | +| [SC1001](https://github.com/koalaman/shellcheck/wiki/SC1001) | This `\c` will be a regular `'c'` in this context. | +| [SC1007](https://github.com/koalaman/shellcheck/wiki/SC1007) | Remove space after `=` if trying to assign a value (or for empty string, use `var='' ...`). | +| [SC1010](https://github.com/koalaman/shellcheck/wiki/SC1010) | Use semicolon or linefeed before `done` (or quote to make it literal). | +| [SC1018](https://github.com/koalaman/shellcheck/wiki/SC1018) | This is a unicode non-breaking space. Delete it and retype as space. | +| [SC1035](https://github.com/koalaman/shellcheck/wiki/SC1035) | You need a space here | +| [SC1045](https://github.com/koalaman/shellcheck/wiki/SC1045) | It's not `foo &; bar`, just `foo & bar`. | +| [SC1065](https://github.com/koalaman/shellcheck/wiki/SC1065) | Trying to declare parameters? Don't. Use `()` and refer to params as `$1`, `$2` etc. | +| [SC1066](https://github.com/koalaman/shellcheck/wiki/SC1066) | Don't use $ on the left side of assignments. | +| [SC1068](https://github.com/koalaman/shellcheck/wiki/SC1068) | Don't put spaces around the `=` in assignments. | +| [SC1077](https://github.com/koalaman/shellcheck/wiki/SC1077) | For command expansion, the tick should slant left (\` vs ยด). | +| [SC1078](https://github.com/koalaman/shellcheck/wiki/SC1078) | Did you forget to close this double-quoted string? | +| [SC1079](https://github.com/koalaman/shellcheck/wiki/SC1079) | This is actually an end quote, but due to next char, it looks suspect. | +| [SC1081](https://github.com/koalaman/shellcheck/wiki/SC1081) | Scripts are case sensitive. Use `if`, not `If`. | +| [SC1083](https://github.com/koalaman/shellcheck/wiki/SC1083) | This `{/}` is literal. Check expression (missing `;/\n`?) or quote it. | +| [SC1086](https://github.com/koalaman/shellcheck/wiki/SC1086) | Don't use `$` on the iterator name in for loops. | +| [SC1087](https://github.com/koalaman/shellcheck/wiki/SC1087) | Braces are required when expanding arrays, as in `${array[idx]}`. | +| [SC1095](https://github.com/koalaman/shellcheck/wiki/SC1095) | You need a space or linefeed between the function name and body. | +| [SC1097](https://github.com/koalaman/shellcheck/wiki/SC1097) | Unexpected `==`. For assignment, use `=`. For comparison, use `[/[[`. | +| [SC1098](https://github.com/koalaman/shellcheck/wiki/SC1098) | Quote/escape special characters when using `eval`, e.g. `eval "a=(b)"`. | +| [SC1099](https://github.com/koalaman/shellcheck/wiki/SC1099) | You need a space before the `#`. | +| [SC2002](https://github.com/koalaman/shellcheck/wiki/SC2002) | Useless cat. Consider cmd < file | .. or cmd file | .. instead. | +| [SC2015](https://github.com/koalaman/shellcheck/wiki/SC2015) | Note that A && B || C is not if-then-else. C may run when A is true. | +| [SC2026](https://github.com/koalaman/shellcheck/wiki/SC2026) | This word is outside of quotes. Did you intend to 'nest '"'single quotes'"' instead'? | +| [SC2028](https://github.com/koalaman/shellcheck/wiki/SC2028) | `echo` won't expand escape sequences. Consider `printf`. | +| [SC2035](https://github.com/koalaman/shellcheck/wiki/SC2035) | Use `./*glob*` or `-- *glob*` so names with dashes won't become options. | +| [SC2046](https://github.com/koalaman/shellcheck/wiki/SC2046) | Quote this to prevent word splitting | +| [SC2086](https://github.com/koalaman/shellcheck/wiki/SC2086) | Double quote to prevent globbing and word splitting. | +| [SC2140](https://github.com/koalaman/shellcheck/wiki/SC2140) | Word is in the form `"A"B"C"` (B indicated). Did you mean `"ABC"` or `"A\"B\"C"`? | +| [SC2154](https://github.com/koalaman/shellcheck/wiki/SC2154) | var is referenced but not assigned. | +| [SC2164](https://github.com/koalaman/shellcheck/wiki/SC2164) | Use cd ... || exit in case `cd` fails. | + +## Develop + +If you are an experienced Haskeller we would be really thankful if you would +tear our code apart in a review. + +### Setup + +1. Clone repository + + ```bash + git clone --recursive git@github.com:hadolint/hadolint.git + ``` + +1. Install the dependencies + + ```bash + stack install + ``` + +### REPL + +The easiest way to try out the parser is using the REPL. + +```bash +# start the repl +stack repl +# parse instruction and look at AST representation +parseString "FROM debian:jessie" +``` + +### Tests + +Run unit tests. + +```bash +stack test +``` + +Run integration tests. + +```bash +./integration_test.sh +``` + +### Parsing + +The Dockerfile is parsed using [Parsec](https://wiki.haskell.org/Parsec) and is +using the lexer `Lexer.hs` and parser `Parser.hs`. + +### AST + +Dockerfile syntax is fully described in the [Dockerfile reference][]. Just take +a look at `Syntax.hs` to see the AST definition. + +## Alternatives + +- RedCoolBeans/[dockerlint](https://github.com/RedCoolBeans/dockerlint/) +- projectatomic/[dockerfile_lint](https://github.com/projectatomic/dockerfile_lint/) + + +[travis-img]: https://travis-ci.org/hadolint/hadolint.svg?branch=master +[travis]: https://travis-ci.org/hadolint/hadolint +[appveyor-img]: https://ci.appveyor.com/api/projects/status//github/hadolint/hadolint?svg=true&branch=master +[appveyor]: https://ci.appveyor.com/project/hadolint/hadolint/branch/master +[license-img]: https://img.shields.io/badge/license-GPL--3-blue.svg +[license]: https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3) +[release-img]: https://img.shields.io/github/release/hadolint/hadolint.svg +[release]: https://github.com/hadolint/hadolint/releases/latest +[downloads-img]: https://img.shields.io/github/downloads/hadolint/hadolint/total.svg +[best practice]: https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices +[shellcheck]: https://github.com/koalaman/shellcheck +[release page]: https://github.com/hadolint/hadolint/releases/latest +[haskell]: https://www.haskell.org/platform/ +[stack]: http://docs.haskellstack.org/en/stable/install_and_upgrade.html +[integration]: docs/INTEGRATION.md +[create an issue]: https://github.com/hadolint/hadolint/issues/new +[dockerfile reference]: http://docs.docker.com/engine/reference/builder/ 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/app/Main.hs b/app/Main.hs new file mode 100644 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,90 @@ +{-# LANGUAGE TemplateHaskell #-} + +module Main where + +import Hadolint.Formatter +import Hadolint.Rules +import Language.Docker.Parser +import Language.Docker.Syntax + +import Control.Applicative +import Data.List (sort) +import Data.Semigroup +import qualified Data.Version as V (showVersion) +import Development.GitRev (gitDescribe) +import Options.Applicative hiding (ParseError) +import Paths_hadolint (version) -- version from hadolint.cabal file +import System.Environment (getArgs) +import System.Exit hiding (die) +import Text.Parsec (ParseError) + +type IgnoreRule = String + +data LintOptions = LintOptions + { showVersion :: Bool + , ignoreRules :: [IgnoreRule] + , dockerfiles :: [String] + } + +ignoreFilter :: [IgnoreRule] -> RuleCheck -> Bool +ignoreFilter ignoredRules (RuleCheck (Metadata code _ _) _ _ _) = code `notElem` ignoredRules + +printChecks :: [RuleCheck] -> IO () +printChecks checks = do + mapM_ (putStrLn . formatCheck) $ sort checks + if null checks + then exitSuccess + else die + +parseOptions :: Parser LintOptions +parseOptions = + LintOptions <$> switch (long "version" <> short 'v' <> help "Show version") <*> + many (strOption (long "ignore" <> help "Ignore rule" <> metavar "RULECODE")) <*> + many (argument str (metavar "DOCKERFILE...")) + +main :: IO () +main = execParser opts >>= lint + where + opts = + info + (helper <*> parseOptions) + (fullDesc <> progDesc "Lint Dockerfile for errors and best practices" <> + header "hadolint - Dockerfile Linter written in Haskell") + +-- | Support UNIX convention of passing "-" instead of "/dev/stdin" +parseFilename :: String -> String +parseFilename "-" = "/dev/stdin" +parseFilename s = s + +lintDockerfile :: [IgnoreRule] -> String -> IO () +lintDockerfile ignoreRules dockerfile = do + ast <- parseFile $ parseFilename dockerfile + checkAst (ignoreFilter ignoreRules) ast + +getVersion :: String +getVersion + | $(gitDescribe) == "UNKNOWN" = + "Haskell Dockerfile Linter " ++ V.showVersion version ++ "-no-git" + | otherwise = "Haskell Dockerfile Linter " ++ $(gitDescribe) + +lint :: LintOptions -> IO () +lint (LintOptions True _ _) = putStrLn getVersion >> exitSuccess +lint (LintOptions _ _ []) = putStrLn "Please provide a Dockerfile" >> exitFailure +lint (LintOptions _ ignored dfiles) = mapM_ (lintDockerfile ignored) dfiles + +checkAst :: (RuleCheck -> Bool) -> Either ParseError Dockerfile -> IO () +checkAst checkFilter ast = + case ast of + Left err -> putStrLn (formatError err) >> exitFailure + Right dockerfile -> printChecks $ filter checkFilter $ analyzeAll dockerfile + +analyzeAll :: Dockerfile -> [RuleCheck] +analyzeAll = analyze rules + +-- Helper to analyze AST quickly in GHCI +analyzeEither :: Either t Dockerfile -> [RuleCheck] +analyzeEither (Left err) = [] +analyzeEither (Right dockerfile) = analyzeAll dockerfile + +die :: IO a +die = exitWith (ExitFailure 1) diff --git a/hadolint.cabal b/hadolint.cabal new file mode 100644 --- /dev/null +++ b/hadolint.cabal @@ -0,0 +1,80 @@ +-- This file has been generated from package.yaml by hpack version 0.20.0. +-- +-- see: https://github.com/sol/hpack +-- +-- hash: 12b5c22d1b02f401b49c4ddf5c4493e77538d2e3d78e138808e187953593aebe + +name: hadolint +version: 1.2.5 +synopsis: Dockerfile Linter JavaScript API +description: A smarter Dockerfile linter that helps you build best practice Docker images. +category: Development +homepage: https://github.com/hadolint/hadolint +author: Lukas Martinelli +maintainer: me@lukasmartinelli.ch +copyright: Lukas Martinelli +license: GPL-3 +license-file: LICENSE +build-type: Simple +cabal-version: >= 1.10 + +extra-source-files: + README.md + +source-repository head + type: git + location: git@github.com:hadolint/hadolint.git + +library + hs-source-dirs: + src + build-depends: + ShellCheck >=0.4.7 + , base >=4.8 && <5 + , bytestring >=0.10 + , language-docker >=2.0.0 + , parsec >=3.1 + , split >=0.2 + exposed-modules: + Hadolint.Bash + Hadolint.Formatter + Hadolint.Rules + other-modules: + Paths_hadolint + default-language: Haskell2010 + +executable hadolint + main-is: Main.hs + hs-source-dirs: + app + build-depends: + base >=4.8 && <5 + , gitrev >=1.3.1 + , hadolint + , language-docker >=2.0.0 + , optparse-applicative <=0.14.0.0 + , parsec >=3.1 + if !(os(osx)) + ld-options: -static -pthread + other-modules: + Paths_hadolint + default-language: Haskell2010 + +test-suite hadolint-unit-tests + type: exitcode-stdio-1.0 + main-is: Spec.hs + hs-source-dirs: + test + build-depends: + HUnit >=1.2 + , ShellCheck >=0.4.7 + , base >=4.8 && <5 + , bytestring >=0.10 + , hadolint + , hspec + , language-docker >=2.0.0 + , parsec >=3.1 + , split >=0.2 + other-modules: + Paths_hadolint + default-language: Haskell2010 diff --git a/src/Hadolint/Bash.hs b/src/Hadolint/Bash.hs new file mode 100644 --- /dev/null +++ b/src/Hadolint/Bash.hs @@ -0,0 +1,16 @@ +module Hadolint.Bash where + +import Data.Functor.Identity (runIdentity) +import ShellCheck.Checker +import ShellCheck.Interface + +shellcheck :: String -> [Comment] +shellcheck bashScript = map comment $ crComments $ runIdentity $ checkScript si spec + where + comment (PositionedComment _ _ c) = c + si = mockedSystemInterface [("", "")] + spec = CheckSpec filename script sourced exclusions (Just Bash) + script = "#!/bin/bash\n" ++ bashScript + filename = "" -- filename can be ommited because we only want the parse results back + sourced = False + exclusions = [] diff --git a/src/Hadolint/Formatter.hs b/src/Hadolint/Formatter.hs new file mode 100644 --- /dev/null +++ b/src/Hadolint/Formatter.hs @@ -0,0 +1,43 @@ +module Hadolint.Formatter + ( formatCheck + , formatError + ) where + +import Control.Monad +import Data.Char (isSpace) +import Hadolint.Rules +import Language.Docker.Syntax +import Text.Parsec.Error + (Message, ParseError, errorMessages, errorPos, messageString, + showErrorMessages) +import Text.Parsec.Pos + +formatError :: ParseError -> String +formatError err = posPart ++ stripNewlines msgPart + where + pos = errorPos err + posPart = sourceName pos ++ ":" ++ show (sourceLine pos) ++ ":" ++ show (sourceColumn pos) + msgPart = + showErrorMessages + "or" + "unknown parse error" + "expecting" + "unexpected" + "end of input" + (errorMessages err) + stripNewlines = + map + (\c -> + if c == '\n' + then ' ' + else c) + +formatCheck :: RuleCheck -> String +formatCheck (RuleCheck metadata source linenumber _) = + formatPos source linenumber ++ code metadata ++ " " ++ message metadata + +formatPos :: Filename -> Linenumber -> String +formatPos source linenumber = + if linenumber >= 0 + then source ++ ":" ++ show linenumber ++ " " + else source ++ " " diff --git a/src/Hadolint/Rules.hs b/src/Hadolint/Rules.hs new file mode 100644 --- /dev/null +++ b/src/Hadolint/Rules.hs @@ -0,0 +1,478 @@ +module Hadolint.Rules where + +import Data.List (intercalate, isInfixOf, isPrefixOf, isSuffixOf) +import Data.List.NonEmpty (toList) +import Data.List.Split (splitOn, splitOneOf) +import Data.Maybe (fromMaybe, isJust, mapMaybe) +import Hadolint.Bash +import Language.Docker.Syntax + +import ShellCheck.Interface + +data Metadata = Metadata + { code :: String + , severity :: Severity + , message :: String + } deriving (Eq) + +-- a check is the application of a rule on a specific part of code +-- the enforced result and the affected position +-- position only records the linenumber at the moment to keep it easy +-- and simple to develop new rules +-- line numbers in the negative range are meant for the global context +data RuleCheck = RuleCheck + { metadata :: Metadata + , filename :: Filename + , linenumber :: Linenumber + , success :: Bool + } deriving (Eq) + +instance Ord RuleCheck where + a `compare` b = linenumber a `compare` linenumber b + +link :: Metadata -> String +link (Metadata code _ _) + | "SC" `isPrefixOf` code = "https://github.com/koalaman/shellcheck/wiki/" ++ code + | "DL" `isPrefixOf` code = "https://github.com/hadolint/hadolint/wiki/" ++ code + | otherwise = "https://github.com/hadolint/hadolint" + +-- a Rule takes a Dockerfile and returns the executed checks +type Rule = Dockerfile -> [RuleCheck] + +-- Apply a function on each instruction and create a check +-- for the according line number +mapInstructions :: Metadata -> (Instruction -> Bool) -> Rule +mapInstructions metadata f = map applyRule + where + applyRule (InstructionPos i source linenumber) = RuleCheck metadata source linenumber (f i) + +instructionRule :: String -> Severity -> String -> (Instruction -> Bool) -> Rule +instructionRule code severity message = mapInstructions $ Metadata code severity message + +dockerfileRule :: String -> Severity -> String -> ([Instruction] -> Bool) -> Rule +dockerfileRule code severity message f = rule + where + rule dockerfile = + [RuleCheck metadata (filename dockerfile) (-1) (f (map instruction dockerfile))] + metadata = Metadata code severity message + filename dockerfile = sourcename $ head dockerfile + +-- Enforce rules on a dockerfile and return failed checks +analyze :: [Rule] -> Dockerfile -> [RuleCheck] +analyze rules dockerfile = filter failed $ concat [r dockerfile | r <- rules] + where + failed (RuleCheck _ _ _ success) = not success + +rules = + [ absoluteWorkdir + , shellcheckBash + , invalidCmd + , copyInsteadAdd + , noRootUser + , noCd + , noSudo + , noAptGetUpgrade + , noApkUpgrade + , noLatestTag + , noUntagged + , aptGetVersionPinned + , aptGetCleanup + , apkAddVersionPinned + , apkAddNoCache + , useAdd + , pipVersionPinned + , npmVersionPinned + , invalidPort + , aptGetNoRecommends + , aptGetYes + , wgetOrCurl + , hasNoMaintainer + , multipleCmds + , multipleEntrypoints + , useShell + ] + +commentMetadata :: ShellCheck.Interface.Comment -> Metadata +commentMetadata (ShellCheck.Interface.Comment severity code message) = + Metadata ("SC" ++ show code) severity message + +shellcheckBash :: Dockerfile -> [RuleCheck] +shellcheckBash = concatMap check + where + check (InstructionPos (Run args) source linenumber) = + rmDup [RuleCheck m source linenumber False | m <- convert args] + check _ = [] + convert args = [commentMetadata c | c <- shellcheck $ unwords args] + rmDup :: [RuleCheck] -> [RuleCheck] + rmDup [] = [] + rmDup (x:xs) = x : rmDup (filter (\y -> metadata x /= metadata y) xs) + +-- Split different bash commands +bashCommands :: [String] -> [[String]] +bashCommands = splitOneOf [";", "|", "&&"] + +absoluteWorkdir = instructionRule code severity message check + where + code = "DL3000" + severity = ErrorC + message = "Use absolute WORKDIR" + check (Workdir dir) = head dir == '$' || head dir == '/' + check _ = True + +hasNoMaintainer = dockerfileRule code severity message check + where + code = "DL4000" + severity = ErrorC + message = "MAINTAINER is deprecated" + check dockerfile = not $ any isMaintainer dockerfile + isMaintainer (Maintainer _) = True + isMaintainer _ = False + +-- Check if a command contains a program call in the Run instruction +usingProgram prog args = or [head cmds == prog | cmds <- bashCommands args] + +multipleCmds = dockerfileRule code severity message check + where + code = "DL4003" + severity = WarningC + message = + "Multiple `CMD` instructions found. If you list more than one `CMD` then only the last \ + \`CMD` will take effect." + check dockerfile = 1 >= length (filter (True ==) $ map isCmd dockerfile) + isCmd (Cmd _) = True + isCmd _ = False + +multipleEntrypoints = dockerfileRule code severity message check + where + code = "DL4004" + severity = ErrorC + message = + "Multiple `ENTRYPOINT` instructions found. If you list more than one `ENTRYPOINT` then \ + \only the last `ENTRYPOINT` will take effect." + check dockerfile = 1 >= length (filter (True ==) $ map isEntrypoint dockerfile) + isEntrypoint (Entrypoint _) = True + isEntrypoint _ = False + +wgetOrCurl = dockerfileRule code severity message check + where + code = "DL4001" + severity = WarningC + message = "Either use Wget or Curl but not both" + check dockerfile = not $ anyCurl dockerfile && anyWget dockerfile + anyCurl = any $ usingCmd "curl" + anyWget = any $ usingCmd "wget" + usingCmd cmd (Run args) = cmd `elem` args + usingCmd _ _ = False + +invalidCmd = instructionRule code severity message check + where + code = "DL3001" + severity = InfoC + message = + "For some bash commands it makes no sense running them in a Docker container like `ssh`, \ + \`vim`, `shutdown`, `service`, `ps`, `free`, `top`, `kill`, `mount`, `ifconfig`" + check (Run args) = head args `notElem` invalidCmds + check _ = True + invalidCmds = ["ssh", "vim", "shutdown", "service", "ps", "free", "top", "kill", "mount"] + +noRootUser = instructionRule code severity message check + where + code = "DL3002" + severity = WarningC + message = "Do not switch to root USER" + check (User user) = + not (isPrefixOf "root:" user || isPrefixOf "0:" user || user == "root" || user == "0") + check _ = True + +noCd = instructionRule code severity message check + where + code = "DL3003" + severity = WarningC + message = "Use WORKDIR to switch to a directory" + check (Run args) = not $ usingProgram "cd" args + check _ = True + +noSudo = instructionRule code severity message check + where + code = "DL3004" + severity = ErrorC + message = + "Do not use sudo as it leads to unpredictable behavior. Use a tool like gosu to enforce \ + \root." + check (Run args) = not $ usingProgram "sudo" args + check _ = True + +noAptGetUpgrade = instructionRule code severity message check + where + code = "DL3005" + severity = ErrorC + message = "Do not use apt-get upgrade or dist-upgrade." + check (Run args) = not $ isInfixOf ["apt-get", "upgrade"] args + check _ = True + +noUntagged = instructionRule code severity message check + where + code = "DL3006" + severity = WarningC + message = "Always tag the version of an image explicitly." + check (From (UntaggedImage image _)) = image == "scratch" + check (From TaggedImage {}) = True + check _ = True + +noLatestTag = instructionRule code severity message check + where + code = "DL3007" + severity = WarningC + message = + "Using latest is prone to errors if the image will ever update. Pin the version explicitly \ + \to a release tag." + check (From (TaggedImage _ tag _)) = tag /= "latest" + check _ = True + +aptGetVersionPinned = instructionRule code severity message check + where + code = "DL3008" + severity = WarningC + message = + "Pin versions in apt get install. Instead of `apt-get install ` use `apt-get \ + \install =`" + check (Run args) = and [versionFixed p | p <- aptGetPackages args] + check _ = True + versionFixed package = "=" `isInfixOf` package + +aptGetPackages :: [String] -> [String] +aptGetPackages args = concat [filter noOption cmd | cmd <- bashCommands args, isAptGetInstall cmd] + where + noOption arg = arg `notElem` options && not ("--" `isPrefixOf` arg) + options = ["apt-get", "install", "-d", "-f", "-m", "-q", "-y", "-qq"] + +aptGetCleanup = instructionRule code severity message check + where + code = "DL3009" + severity = InfoC + message = "Delete the apt-get lists after installing something" + check (Run args) = not (hasUpdate args) || hasCleanup args + check _ = True + hasCleanup cmd = ["rm", "-rf", "/var/lib/apt/lists/*"] `isInfixOf` cmd + hasUpdate cmd = ["apt-get", "update"] `isInfixOf` cmd + +dropOptionsWithArg :: [String] -> [String] -> [String] +dropOptionsWithArg os [] = [] +dropOptionsWithArg os (x:xs) + | x `elem` os = dropOptionsWithArg os (drop 1 xs) + | otherwise = x : dropOptionsWithArg os xs + +noApkUpgrade = instructionRule code severity message check + where + code = "DL3017" + severity = ErrorC + message = "Do not use apk upgrade" + check (Run args) = not $ isInfixOf ["apk", "upgrade"] args + check _ = True + +isApkAdd :: [String] -> Bool +isApkAdd cmd = ["apk"] `isInfixOf` cmd && ["add"] `isInfixOf` cmd + +apkAddVersionPinned = instructionRule code severity message check + where + code = "DL3018" + severity = WarningC + message = + "Pin versions in apk add. Instead of `apk add ` use `apk add =`" + check (Run args) = and [versionFixed p | p <- apkAddPackages args] + check _ = True + versionFixed package = "=" `isInfixOf` package + +apkAddPackages :: [String] -> [String] +apkAddPackages args = + concat + [ filter noOption (dropOptionsWithArg ["-t", "--virtual"] cmd) + | cmd <- bashCommands args + , isApkAdd cmd + ] + where + noOption arg = arg `notElem` options && not ("--" `isPrefixOf` arg) + options = ["apk", "add", "-q", "-p", "-v", "-f", "-t"] + +apkAddNoCache = instructionRule code severity message check + where + code = "DL3019" + severity = InfoC + message = + "Use the `--no-cache` switch to avoid the need to use `--update` and remove \ + \`/var/cache/apk/*` when done installing packages" + check (Run args) = not (isApkAdd args) || hasNoCacheOption args + check _ = True + hasNoCacheOption cmd = ["--no-cache"] `isInfixOf` cmd + +useAdd = instructionRule code severity message check + where + code = "DL3010" + severity = InfoC + message = "Use ADD for extracting archives into an image" + check (Copy (CopyArgs srcs _ _ _)) = + and + [ not (format `isSuffixOf` src) + | SourcePath src <- toList srcs + , format <- archiveFormats + ] + check _ = True + archiveFormats = [".tar", ".gz", ".bz2", "xz"] + +invalidPort = instructionRule code severity message check + where + code = "DL3011" + severity = ErrorC + message = "Valid UNIX ports range from 0 to 65535" + check (Expose (Ports ports)) = + and [p <= 65535 | Port p _ <- ports] && + and [l <= 65535 && m <= 65535 | PortRange l m <- ports] + check _ = True + +pipVersionPinned = instructionRule code severity message check + where + code = "DL3013" + severity = WarningC + message = + "Pin versions in pip. Instead of `pip install ` use `pip install \ + \==`" + check (Run args) = + not (isPipInstall args && not (isRecursiveInstall args)) || all versionFixed (packages args) + check _ = True + isVersionedGit :: String -> Bool + isVersionedGit package = "git+http" `isInfixOf` package && "@" `isInfixOf` package + versionSymbols = ["==", ">=", "<=", ">", "<", "!="] + hasVersionSymbol :: String -> Bool + hasVersionSymbol package = or [s `isInfixOf` package | s <- versionSymbols] + versionFixed :: String -> Bool + versionFixed package = hasVersionSymbol package || isVersionedGit package + packages :: [String] -> [String] + packages args = concat [filter noOption cmd | cmd <- bashCommands args, isPipInstall cmd] + where + noOption arg = arg `notElem` options + options = + [ "pip" + , "pip2" + , "pip3" + , "install" + , "--user" + , "--disable-pip-version-check" + , "--no-cache-dir" + ] + isPipInstall :: [String] -> Bool + isPipInstall cmd = + ["pip", "install"] `isInfixOf` cmd || + ["pip3", "install"] `isInfixOf` cmd || ["pip2", "install"] `isInfixOf` cmd + isRecursiveInstall :: [String] -> Bool + isRecursiveInstall cmd = ["-r"] `isInfixOf` cmd + +{-| + Rule for pinning NPM packages to version, tag, or commit + supported formats by Hadolint + npm install (with no args, in package dir) + npm install [<@scope>/] + npm install [<@scope>/]@ + npm install [<@scope>/]@ + npm install git[+http|+https]:////[#|#semver:] + npm install git+ssh://:/[#|#semver:] +-} +npmVersionPinned = instructionRule code severity message check + where + code = "DL3016" + severity = WarningC + message = + "Pin versions in npm. Instead of `npm install ` use `npm install \ + \@`" + check (Run args) = all versionFixed (packages args) + check _ = True + packages :: [String] -> [String] + packages args = concat [filter noOption cmd | cmd <- bashCommands args, isNpmInstall cmd] + where + noOption arg = arg `notElem` options + options = ["npm", "install", "--global"] + isNpmInstall :: [String] -> Bool + isNpmInstall cmd = ["npm", "install"] `isInfixOf` cmd + versionFixed :: String -> Bool + versionFixed package = + if hasGitPrefix package + then isVersionedGit package + else hasVersionSymbol package + gitPrefixes = ["git://", "git+ssh://", "git+http://", "git+https://"] + hasGitPrefix :: String -> Bool + hasGitPrefix package = or [p `isPrefixOf` package | p <- gitPrefixes] + isVersionedGit :: String -> Bool + isVersionedGit package = "#" `isInfixOf` package + hasVersionSymbol :: String -> Bool + hasVersionSymbol package = "@" `isInfixOf` dropScope package + where + dropScope package = + if "@" `isPrefixOf` package + then dropWhile ('/' <) package + else package + +isAptGetInstall cmd = ["apt-get"] `isInfixOf` cmd && ["install"] `isInfixOf` cmd + +aptGetYes = instructionRule code severity message check + where + code = "DL3014" + severity = WarningC + message = "Use the `-y` switch to avoid manual input `apt-get -y install `" + check (Run args) = not (isAptGetInstall args) || hasYesOption args + check _ = True + hasYesOption cmd = + ["-y"] `isInfixOf` cmd || + ["--yes"] `isInfixOf` cmd || ["-qq"] `isInfixOf` cmd || startsWithYesFlag cmd + startsWithYesFlag cmd = True `elem` ["-y" `isInfixOf` arg | arg <- cmd] + +aptGetNoRecommends = instructionRule code severity message check + where + code = "DL3015" + severity = InfoC + message = "Avoid additional packages by specifying `--no-install-recommends`" + check (Run args) = not (isAptGetInstall args) || hasNoRecommendsOption args + check _ = True + hasNoRecommendsOption cmd = ["--no-install-recommends"] `isInfixOf` cmd + +isArchive :: String -> Bool +isArchive path = + True `elem` + [ ftype `isSuffixOf` path + | ftype <- + [ ".tar" + , ".gz" + , ".bz2" + , ".xz" + , ".zip" + , ".tgz" + , ".tb2" + , ".tbz" + , ".tbz2" + , ".lz" + , ".lzma" + , ".tlz" + , ".txz" + , ".Z" + , ".tZ" + ] + ] + +isUrl :: String -> Bool +isUrl path = True `elem` [proto `isPrefixOf` path | proto <- ["https://", "http://"]] + +copyInsteadAdd = instructionRule code severity message check + where + code = "DL3020" + severity = ErrorC + message = "Use COPY instead of ADD for files and folders" + check (Add (AddArgs srcs _ _)) = + and [isArchive src || isUrl src | SourcePath src <- toList srcs] + check _ = True + +useShell = instructionRule code severity message check + where + code = "DL4005" + severity = WarningC + message = "Use SHELL to change the default shell" + check (Run args) = not $ any shellSymlink (bashCommands args) + check _ = True + shellSymlink args = usingProgram "ln" args && isInfixOf ["/bin/sh"] args diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,287 @@ +import Test.HUnit hiding (Label) +import Test.Hspec + +import Hadolint.Formatter +import Hadolint.Rules + +import Language.Docker.Parser + +import Data.List (find) +import Data.Maybe (fromMaybe, isJust) + +main :: IO () +main = + hspec $ do + describe "FROM rules" $ do + it "no untagged" $ ruleCatches noUntagged "FROM debian" + it "no untagged with name" $ ruleCatches noUntagged "FROM debian AS builder" + it "explicit latest" $ ruleCatches noLatestTag "FROM debian:latest" + it "explicit latest with name" $ ruleCatches noLatestTag "FROM debian:latest AS builder" + it "explicit tagged" $ ruleCatchesNot noLatestTag "FROM debian:jessie" + it "explicit SHA" $ + ruleCatchesNot noLatestTag + "FROM debian@sha256:\ + \7959ed6f7e35f8b1aaa06d1d8259d4ee25aa85a086d5c125480c333183f9deeb" + it "explicit tagged with name" $ + ruleCatchesNot noLatestTag "FROM debian:jessie AS builder" + -- + describe "no root or sudo rules" $ do + it "sudo" $ ruleCatches noSudo "RUN sudo apt-get update" + it "no root" $ ruleCatches noRootUser "USER root" + it "no root" $ ruleCatchesNot noRootUser "USER foo" + it "no root UID" $ ruleCatches noRootUser "USER 0" + it "no root:root" $ ruleCatches noRootUser "USER root:root" + it "no root UID:GID" $ ruleCatches noRootUser "USER 0:0" + it "install sudo" $ ruleCatchesNot noSudo "RUN apt-get install sudo" + it "sudo chained programs" $ + ruleCatches noSudo "RUN apt-get update && sudo apt-get install" + -- + describe "invalid CMD rules" $ do + it "invalid cmd" $ ruleCatches invalidCmd "RUN top" + it "install ssh" $ ruleCatchesNot invalidCmd "RUN apt-get install ssh" + -- + describe "apt-get rules" $ do + it "apt upgrade" $ ruleCatches noAptGetUpgrade "RUN apt-get update && apt-get upgrade" + it "apt-get version pinning" $ + ruleCatches aptGetVersionPinned "RUN apt-get update && apt-get install python" + it "apt-get no cleanup" $ + ruleCatches aptGetCleanup "RUN apt-get update && apt-get install python" + it "apt-get cleanup" $ + ruleCatchesNot + aptGetCleanup + "RUN apt-get update && apt-get install python && rm -rf /var/lib/apt/lists/*" + it "apt-get pinned chained" $ + let dockerfile = + [ "RUN apt-get update \\" + , " && apt-get -y --no-install-recommends install nodejs=0.10 \\" + , " && rm -rf /var/lib/apt/lists/*" + ] + in ruleCatchesNot aptGetVersionPinned $ unlines dockerfile + it "apt-get pinned regression" $ + let dockerfile = + [ "RUN apt-get update && apt-get install --no-install-recommends -y \\" + , "python-demjson=2.2.2* \\" + , "wget=1.16.1* \\" + , "git=1:2.5.0* \\" + , "ruby=1:2.1.*" + ] + in ruleCatchesNot aptGetVersionPinned $ unlines dockerfile + it "has deprecated maintainer" $ + ruleCatches hasNoMaintainer "FROM busybox\nMAINTAINER hudu@mail.com" + -- + describe "apk add rules" $ do + it "apk upgrade" $ ruleCatches noApkUpgrade "RUN apk update && apk upgrade" + it "apk add version pinning single" $ ruleCatches apkAddVersionPinned "RUN apk add flex" + it "apk add no version pinning single" $ + ruleCatchesNot apkAddVersionPinned "RUN apk add flex=2.6.4-r1" + it "apk add version pinned chained" $ + let dockerfile = + [ "RUN apk add --no-cache flex=2.6.4-r1 \\" + , " && pip install -r requirements.txt" + ] + in ruleCatchesNot apkAddVersionPinned $ unlines dockerfile + it "apk add version pinned regression" $ + let dockerfile = + [ "RUN apk add --no-cache \\" + , "flex=2.6.4-r1 \\" + , "libffi=3.2.1-r3 \\" + , "python2=2.7.13-r1 \\" + , "libbz2=1.0.6-r5" + ] + in ruleCatchesNot apkAddVersionPinned $ unlines dockerfile + it "apk add version pinned regression - one missed" $ + let dockerfile = + [ "RUN apk add --no-cache \\" + , "flex=2.6.4-r1 \\" + , "libffi \\" + , "python2=2.7.13-r1 \\" + , "libbz2=1.0.6-r5" + ] + in ruleCatches apkAddVersionPinned $ unlines dockerfile + it "apk add with --no-cache" $ ruleCatches apkAddNoCache "RUN apk add flex=2.6.4-r1" + it "apk add without --no-cache" $ + ruleCatchesNot apkAddNoCache "RUN apk add --no-cache flex=2.6.4-r1" + it "apk add virtual package" $ + let dockerfile = + [ "RUN apk add \\" + , "--virtual build-dependencies \\" + , "python-dev=1.1.1 build-base=2.2.2 wget=3.3.3 \\" + , "&& pip install -r requirements.txt \\" + , "&& python setup.py install \\" + , "&& apk del build-dependencies" + ] + in ruleCatchesNot apkAddVersionPinned $ unlines dockerfile + -- + describe "EXPOSE rules" $ do + it "invalid port" $ ruleCatches invalidPort "EXPOSE 80000" + it "valid port" $ ruleCatchesNot invalidPort "EXPOSE 60000" + -- + describe "pip pinning" $ do + it "pip2 version not pinned" $ + ruleCatches pipVersionPinned "RUN pip2 install MySQL_python" + it "pip3 version not pinned" $ + ruleCatches pipVersionPinned "RUN pip3 install MySQL_python" + it "pip3 version pinned" $ + ruleCatchesNot pipVersionPinned "RUN pip3 install MySQL_python==1.2.2" + it "pip install requirements" $ + ruleCatchesNot pipVersionPinned "RUN pip install -r requirements.txt" + it "pip version not pinned" $ + ruleCatches pipVersionPinned "RUN pip install MySQL_python" + it "pip version pinned" $ + ruleCatchesNot pipVersionPinned "RUN pip install MySQL_python==1.2.2" + it "pip install git" $ + ruleCatchesNot + pipVersionPinned + "RUN pip install git+https://github.com/rtfd/r-ext.git@0.6-alpha#egg=r-ext" + it "pip install unversioned git" $ + ruleCatches + pipVersionPinned + "RUN pip install git+https://github.com/rtfd/read-ext.git#egg=read-ext" + it "pip install upper bound" $ + ruleCatchesNot pipVersionPinned "RUN pip install 'alabaster>=0.7'" + it "pip install lower bound" $ + ruleCatchesNot pipVersionPinned "RUN pip install 'alabaster<0.7'" + it "pip install excluded version" $ + ruleCatchesNot pipVersionPinned "RUN pip install 'alabaster!=0.7'" + it "pip install user directory" $ + ruleCatchesNot pipVersionPinned "RUN pip install MySQL_python==1.2.2 --user" + it "pip install no pip version check" $ + ruleCatchesNot + pipVersionPinned + "RUN pip install MySQL_python==1.2.2 --disable-pip-version-check" + it "pip install no cache dir" $ + ruleCatchesNot pipVersionPinned "RUN pip install MySQL_python==1.2.2 --no-cache-dir" + it "pip install extra argument with '--'" $ + ruleCatches + pipVersionPinned + "RUN pip install MySQL_python==1.2.2 --user --extra-arg" + it "pip install extra argument with '-'" $ + ruleCatches pipVersionPinned "RUN pip install MySQL_python==1.2.2 --user -X" + -- + describe "npm pinning" $ do + it "version pinned in package.json" $ ruleCatchesNot npmVersionPinned "RUN npm install" + it "version pinned" $ ruleCatchesNot npmVersionPinned "RUN npm install express@4.1.1" + it "version pinned with scope" $ + ruleCatchesNot npmVersionPinned "RUN npm install @myorg/privatepackage@\">=0.1.0\"" + it "version pinned multiple packages" $ + ruleCatchesNot npmVersionPinned "RUN npm install express@\"4.1.1\" sax@0.1.1" + it "version pinned with --global" $ + ruleCatchesNot npmVersionPinned "RUN npm install --global express@\"4.1.1\"" + it "commit pinned for git+ssh" $ + ruleCatchesNot + npmVersionPinned + "RUN npm install git+ssh://git@github.com:npm/npm.git#v1.0.27" + it "commit pinned for git+http" $ + ruleCatchesNot + npmVersionPinned + "RUN npm install git+http://isaacs@github.com/npm/npm#semver:^5.0" + it "commit pinned for git+https" $ + ruleCatchesNot + npmVersionPinned + "RUN npm install git+https://isaacs@github.com/npm/npm.git#v1.0.27" + it "commit pinned for git" $ + ruleCatchesNot + npmVersionPinned + "RUN npm install git://github.com/npm/npm.git#v1.0.27" + --version range is not supported + --it "version pinned with scope" $ + -- ruleCatchesNot npmVersionPinned "RUN npm install @myorg/privatepackage@\">=0.1.0 <0.2.0\"" + it "version not pinned" $ ruleCatches npmVersionPinned "RUN npm install express" + it "version not pinned with scope" $ + ruleCatches npmVersionPinned "RUN npm install @myorg/privatepackage" + it "version not pinned multiple packages" $ + ruleCatches npmVersionPinned "RUN npm install express sax@0.1.1" + it "version not pinned with --global" $ + ruleCatches npmVersionPinned "RUN npm install --global express" + it "commit not pinned for git+ssh" $ + ruleCatches npmVersionPinned "RUN npm install git+ssh://git@github.com:npm/npm.git" + it "commit not pinned for git+http" $ + ruleCatches npmVersionPinned "RUN npm install git+http://isaacs@github.com/npm/npm" + it "commit not pinned for git+https" $ + ruleCatches + npmVersionPinned + "RUN npm install git+https://isaacs@github.com/npm/npm.git" + it "commit not pinned for git" $ + ruleCatches npmVersionPinned "RUN npm install git://github.com/npm/npm.git" + -- + describe "use SHELL" $ do + it "RUN ln" $ ruleCatches useShell "RUN ln -sfv /bin/bash /bin/sh" + it "RUN ln with unrelated symlinks" $ + ruleCatchesNot useShell "RUN ln -sf /bin/true /sbin/initctl" + it "RUN ln with multiple acceptable commands" $ + ruleCatchesNot useShell "RUN ln -s foo bar && unrelated && something_with /bin/sh" + -- + describe "COPY rules" $ do + it "use add" $ ruleCatches useAdd "COPY packaged-app.tar /usr/src/app" + it "use not add" $ ruleCatchesNot useAdd "COPY package.json /usr/src/app" + -- + describe "other rules" $ do + it "apt-get auto yes" $ ruleCatches aptGetYes "RUN apt-get install python" + it "apt-get yes shortflag" $ ruleCatchesNot aptGetYes "RUN apt-get install -yq python" + it "apt-get yes quiet level 2 implies -y" $ + ruleCatchesNot aptGetYes "RUN apt-get install -qq python" + it "apt-get yes different pos" $ + ruleCatchesNot aptGetYes "RUN apt-get install -y python" + it "apt-get with auto yes" $ ruleCatchesNot aptGetYes "RUN apt-get -y install python" + it "apt-get with auto expanded yes" $ + ruleCatchesNot aptGetYes "RUN apt-get --yes install python" + it "apt-get install recommends" $ + ruleCatchesNot + aptGetNoRecommends + "RUN apt-get install --no-install-recommends python" + it "apt-get no install recommends" $ + ruleCatches aptGetNoRecommends "RUN apt-get install python" + it "apt-get no install recommends" $ + ruleCatches aptGetNoRecommends "RUN apt-get -y install python" + it "apt-get version" $ + ruleCatchesNot aptGetVersionPinned "RUN apt-get install -y python=1.2.2" + it "apt-get pinned" $ + ruleCatchesNot + aptGetVersionPinned + "RUN apt-get -y --no-install-recommends install nodejs=0.10" + it "has maintainer" $ ruleCatches hasNoMaintainer "FROM debian\nMAINTAINER Lukas" + it "has maintainer first" $ ruleCatches hasNoMaintainer "MAINTAINER Lukas\nFROM DEBIAN" + it "has no maintainer" $ ruleCatchesNot hasNoMaintainer "FROM debian" + it "using add" $ ruleCatches copyInsteadAdd "ADD file /usr/src/app/" + it "many cmds" $ ruleCatches multipleCmds "CMD /bin/true\nCMD /bin/true" + it "single cmd" $ ruleCatchesNot multipleCmds "CMD /bin/true" + it "no cmd" $ ruleCatchesNot multipleEntrypoints "FROM busybox" + it "many entries" $ + ruleCatches multipleEntrypoints "ENTRYPOINT /bin/true\nENTRYPOINT /bin/true" + it "single entry" $ ruleCatchesNot multipleEntrypoints "ENTRYPOINT /bin/true" + it "no entry" $ ruleCatchesNot multipleEntrypoints "FROM busybox" + it "workdir variable" $ ruleCatchesNot absoluteWorkdir "WORKDIR ${work}" + it "scratch" $ ruleCatchesNot noUntagged "FROM scratch" + -- + describe "add files and archives" $ do + it "add for tar" $ ruleCatchesNot copyInsteadAdd "ADD file.tar /usr/src/app/" + it "add for zip" $ ruleCatchesNot copyInsteadAdd "ADD file.zip /usr/src/app/" + it "add for gzip" $ ruleCatchesNot copyInsteadAdd "ADD file.gz /usr/src/app/" + it "add for bz2" $ ruleCatchesNot copyInsteadAdd "ADD file.bz2 /usr/src/app/" + it "add for xz" $ ruleCatchesNot copyInsteadAdd "ADD file.xz /usr/src/app/" + it "add for tgz" $ ruleCatchesNot copyInsteadAdd "ADD file.tgz /usr/src/app/" + it "add for url" $ ruleCatchesNot copyInsteadAdd "ADD http://file.com /usr/src/app/" + -- + describe "format error" $ + it "display error after line pos" $ do + let ast = parseString "FOM debian:jessie" + expectedMsg = ":1:2 unexpected \"O\" expecting FROM" + case ast of + Left err -> assertEqual "Unexpected error msg" expectedMsg (formatError err) + Right _ -> assertFailure "AST should fail parsing" + +assertChecks rule s f = + case parseString (s ++ "\n") of + Left err -> assertFailure $ show err + Right dockerfile -> f $ analyze [rule] dockerfile + +-- Assert a failed check exists for rule +ruleCatches :: Rule -> String -> Assertion +ruleCatches rule s = assertChecks rule s f + where + f checks = assertEqual "No check for rule found" 1 $ length checks + +ruleCatchesNot :: Rule -> String -> Assertion +ruleCatchesNot rule s = assertChecks rule s f + where + f checks = assertEqual "Found check of rule" 0 $ length checks