diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e72bfdd
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
\ No newline at end of file
diff --git a/README.md b/README.md
index 0343c8a..c4f6755 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@
[](https://en.cryptobadges.io/donate/3Cd54T1EB6WHRcechq1dRCGF6vY2HHhkdk)
[](https://en.cryptobadges.io/donate/0x064AA753EF36e5641E2Ee3C9BbC117F6aFe35F62)
[](https://www.codacy.com/gh/mr-pmillz/pimp-my-shell/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mr-pmillz/pimp-my-shell&utm_campaign=Badge_Grade)
+[](https://goreportcard.com/report/github.com/mr-pmillz/pimp-my-shell)
diff --git a/extra/extra.go b/extra/extra.go
index 13c78f1..0a90650 100644
--- a/extra/extra.go
+++ b/extra/extra.go
@@ -30,10 +30,6 @@ func InstallExtraPackages(osType string, dirs *localio.Directories, packages *lo
if err := localio.BrewInstallProgram("gnu-sed", "gsed", packages); err != nil {
return err
}
- // brew tap cjbassi/gotop
- if err := localio.BrewTap("cjbassi/gotop", packages); err != nil {
- return err
- }
// install gotop
if err := localio.BrewInstallProgram("gotop", "gotop", packages); err != nil {
return err
@@ -98,12 +94,16 @@ func InstallExtraPackages(osType string, dirs *localio.Directories, packages *lo
}
// install gotop
if _, exists := localio.CommandExists("go"); exists {
- if _, exists := localio.CommandExists("gotop"); !exists {
- if err := localio.RunCommandPipeOutput("go get github.com/cjbassi/gotop"); err != nil {
+ if _, exists = localio.CommandExists("gotop"); !exists {
+ if err := localio.RunCommandPipeOutput("go install github.com/xxxserxxx/gotop/v4/cmd/gotop@latest"); err != nil {
return err
}
}
}
+ // ensure apt-transport-https is installed. Prevents apt-get error exit code 100
+ if err := localio.AptInstall(packages, "apt-transport-https"); err != nil {
+ return err
+ }
// install cowsay
if err := localio.AptInstall(packages, "cowsay", "bat"); err != nil {
return err
diff --git a/extra/extra_test.go b/extra/extra_test.go
index a6ac5d8..5f41a93 100644
--- a/extra/extra_test.go
+++ b/extra/extra_test.go
@@ -2,6 +2,7 @@ package extra
import (
"pimp-my-shell/localio"
+ "runtime"
"testing"
)
@@ -10,6 +11,19 @@ func TestInstallExtraPackages(t *testing.T) {
if err != nil {
t.Errorf("failed to create Directories type: %v", err)
}
+ osType := runtime.GOOS
+ switch osType {
+ case "linux":
+ if err = localio.DownloadAndInstallLatestVersionOfGolang(dirs.HomeDir); err != nil {
+ t.Errorf("couldn't download and install golang: %v", err)
+ }
+ if err = localio.RunCommandPipeOutput("go version"); err != nil {
+ t.Errorf("couldn't get go version: %v", err)
+ }
+ default:
+ //DoNothing
+ }
+
type args struct {
osType string
dirs *localio.Directories
@@ -26,14 +40,38 @@ func TestInstallExtraPackages(t *testing.T) {
packages: &localio.InstalledPackages{
AptInstalledPackages: nil,
BrewInstalledPackages: &localio.BrewInstalled{
- Names: []string{"bat", "lsd", "gnu-sed", "gotop", "yamllint", "git-delta"}, CaskFullNames: []string{"bat"}, Taps: []string{"homebrew/core", "cjbassi/gotop"},
+ Names: []string{"bat", "lsd", "gnu-sed", "gotop", "yamllint", "git-delta"}, CaskFullNames: []string{"gotop"}, Taps: []string{"homebrew/core", "cjbassi/gotop"},
+ },
+ }}, false},
+ {"Test InstallExtraPackages darwin lots of packages already installed 2", args{
+ osType: "darwin",
+ dirs: dirs,
+ packages: &localio.InstalledPackages{
+ AptInstalledPackages: nil,
+ BrewInstalledPackages: &localio.BrewInstalled{
+ Names: []string{"aom", "apr", "apr-util", "argon2", "aspell", "assimp", "autoconf", "bdw-gc", "binwalk", "boost", "brotli", "c-ares", "ca-certificates",
+ "cairo", "cheat", "cmake", "cointop", "coreutils", "cscope", "curl", "dbus", "deployer", "docbook", "docbook-xsl", "double-conversion", "exiftool",
+ "fontconfig", "freetds", "freetype", "fribidi", "gcc", "gd", "gdbm", "gdk-pixbuf", "gettext", "ghostscript", "git-quick-stats",
+ "github-markdown-toc", "glib", "gmp", "gnu-getopt", "gnu-sed", "gnupg", "gnutls", "gobject-introspection", "graphite2", "graphviz", "gts", "guile", "gulp-cli",
+ "harfbuzz", "helm", "htop", "hunspell", "icu4c", "ilmbase", "imagemagick", "imath", "iproute2mac", "ipython", "isl", "jansson", "jasper", "jbig2dec", "jemalloc",
+ "jpeg", "jq", "kind", "krb5", "lastpass-cli", "libarchive", "libassuan", "libb2", "libde265", "libev", "libevent", "libffi", "libgcrypt", "libgpg-error", "libheif",
+ "libidn", "libidn2", "libimagequant", "libksba", "liblqr", "libmaxminddb", "libmetalink", "libmpc", "libnghttp2", "libomp", "libpng", "libpq", "libproxy", "libpthread-stubs",
+ "libraqm", "librsvg", "libsmi", "libsodium", "libssh", "libssh2", "libtasn1", "libtiff", "libtool", "libunistring", "libusb", "libuv", "libx11", "libxau", "libxcb", "libxdmcp",
+ "libxext", "libxrender", "libyaml", "libzip", "little-cms2", "lnav", "lsd", "lua", "lz4", "lzo", "m4", "macvim", "md4c", "mpdecimal", "mpfr", "msodbcsql17", "mssql-tools", "mysql",
+ "ncurses", "neofetch", "netpbm", "nettle", "nghttp2", "nmap", "node", "npth", "nspr", "nss", "numpy", "oniguruma", "openblas", "openexr", "openjdk", "openjpeg", "openldap", "openssl@1.1",
+ "p11-kit", "p7zip", "packer", "pango", "pcre", "pcre2", "php", "php@7.3", "pillow", "pinentry", "pixman", "pkg-config", "poppler", "popt", "protobuf", "putty", "pyenv", "pyenv-virtualenv",
+ "python@3.10", "python@3.8", "python@3.9", "qt", "qt@5", "readline", "reattach-to-user-namespace", "rsync", "rtmpdump", "ruby", "screenresolution", "shared-mime-info", "shellcheck", "six",
+ "sqlite", "ssdeep", "swaks", "tcl-tk", "telnet", "terraform", "tidy-html5", "tmux", "tree", "unbound", "unixodbc", "unrar", "unzip", "utf8proc", "watch", "webp", "wget", "x265", "xmlto",
+ "xorgproto", "xxhash", "xz", "yamllint", "zeromq", "zstd"},
+ CaskFullNames: []string{"font-meslo-lg-nerd-font", "wireshark"},
+ Taps: []string{"hashicorp/tap", "homebrew/core", "microsoft/mssql-release"},
},
}}, false},
- {"Test InstallExtraPackages Linux 2", args{
+ {"Test InstallExtraPackages Linux 3", args{
osType: "linux",
dirs: dirs,
packages: &localio.InstalledPackages{
- AptInstalledPackages: &localio.AptInstalled{Name: []string{"bat", "lsd", "gotop", "delta"}},
+ AptInstalledPackages: &localio.AptInstalled{Name: []string{"bat", "lsd", "delta"}},
BrewInstalledPackages: nil,
}}, false},
}
diff --git a/githubapi/githubapi.go b/githubapi/githubapi.go
index ac8b701..7d6e0c4 100644
--- a/githubapi/githubapi.go
+++ b/githubapi/githubapi.go
@@ -8,7 +8,6 @@ import (
"strings"
"github.com/google/go-github/v39/github"
- "github.com/klauspost/cpuid/v2"
)
// ReleaseAssets ...
@@ -68,16 +67,7 @@ func DownloadLatestRelease(osType string, dirs *localio.Directories, owner, repo
return "", err
}
- var cpuType string
- cpuid.Detect()
- if cpuid.CPU.VendorID.String() == "AMD" || cpuid.CPU.VendorID.String() == "Intel" && cpuid.CPU.CacheLine == 64 {
- cpuType = "AMD64"
- } else if cpuid.CPU.VendorID.String() == "ARM" && cpuid.CPU.CacheLine == 64 {
- cpuType = "ARM64"
- } else {
- cpuType = ""
- }
-
+ cpuType := localio.GetCPUType()
switch osType {
case "darwin":
switch cpuType {
diff --git a/localio/localio.go b/localio/localio.go
index b4504c6..5158e3c 100644
--- a/localio/localio.go
+++ b/localio/localio.go
@@ -5,6 +5,7 @@ import (
"bytes"
"context"
"fmt"
+ "github.com/klauspost/cpuid/v2"
"github.com/schollz/progressbar/v3"
"github.com/tidwall/gjson"
"io"
@@ -14,6 +15,7 @@ import (
"os"
"os/exec"
"os/user"
+ "path"
"path/filepath"
"runtime"
"strings"
@@ -128,6 +130,68 @@ func DownloadFile(dest, url string) error {
return err
}
+// GetCPUType Returns the CPU type for the current runtime environment
+func GetCPUType() string {
+ cpuid.Detect()
+ if cpuid.CPU.VendorID.String() == "AMD" || cpuid.CPU.VendorID.String() == "Intel" && cpuid.CPU.CacheLine == 64 {
+ return "AMD64"
+ } else if cpuid.CPU.VendorID.String() == "ARM" && cpuid.CPU.CacheLine == 64 {
+ return "ARM64"
+ } else {
+ return ""
+ }
+}
+
+// DownloadAndInstallLatestVersionOfGolang Only for linux x86_64. Mac uses homebrew
+func DownloadAndInstallLatestVersionOfGolang(homeDir string) error {
+ if !CorrectOS("linux") {
+ return nil
+ }
+ req, err := http.NewRequest("GET", "https://golang.org/VERSION?m=text", nil)
+ if err != nil {
+ return err
+ }
+
+ resp, err := http.DefaultClient.Do(req)
+ if err != nil {
+ return err
+ }
+ defer resp.Body.Close()
+ goversion, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return err
+ }
+ latestGoVersion := string(goversion)
+
+ switch GetCPUType() {
+ case "AMD64":
+ armGoURL := fmt.Sprintf("https://dl.google.com/go/%s.linux-arm64.tar.gz", latestGoVersion)
+ dest := fmt.Sprintf("%s/%s", homeDir, path.Base(armGoURL))
+ if err = DownloadFile(dest, armGoURL); err != nil {
+ return err
+ }
+ // // Now extract the go binary. pimp-my-shell ensures that ~/.zshrc will already have the path setup for you
+ if err = RunCommandPipeOutput(fmt.Sprintf("sudo rm -rf /usr/local/go && tar -C /usr/local -xzf %s || true", dest)); err != nil {
+ return err
+ }
+
+ case "ARM64":
+ amdGoURL := fmt.Sprintf("https://dl.google.com/go/%s.linux-amd64.tar.gz", latestGoVersion)
+ dest := fmt.Sprintf("%s/%s", homeDir, path.Base(amdGoURL))
+ if err = DownloadFile(dest, amdGoURL); err != nil {
+ return err
+ }
+
+ if err = RunCommandPipeOutput(fmt.Sprintf("sudo rm -rf /usr/local/go && tar -C /usr/local -xzf %s || true", dest)); err != nil {
+ return err
+ }
+ default:
+ fmt.Println("[-] Couldn't download and install golang Unsupported CPU... Pimp-My-Shell only supports 64 bit")
+ }
+
+ return nil
+}
+
// RunCommands ...
func RunCommands(cmds []string) error {
for _, c := range cmds {
@@ -194,7 +258,7 @@ func EmbedFileCopy(dst string, src fs.File) error {
return nil
}
-// EmbedFileStringAppendToDest ...
+// EmbedFileStringAppendToDest takes a slice of bytes and writes it as a string to dest file path
func EmbedFileStringAppendToDest(data []byte, dest string) error {
fmt.Printf("[+] Appending: \n%s\n -> %s\n", string(data), dest)
fileDest, err := ResolveAbsPath(dest)
@@ -324,7 +388,7 @@ func Contains(s []string, str string) bool {
return false
}
-// CorrectOS ...
+// CorrectOS ... Useful for go tests
func CorrectOS(osType string) bool {
operatingSystem := runtime.GOOS
if operatingSystem == osType {
diff --git a/localio/localio_test.go b/localio/localio_test.go
index dbb93f8..002d390 100644
--- a/localio/localio_test.go
+++ b/localio/localio_test.go
@@ -1,13 +1,174 @@
package localio
import (
+ "embed"
"fmt"
+ "io/fs"
"os"
"os/user"
"reflect"
+ "runtime"
"testing"
)
+//go:embed test/*
+var testEmbedFiles embed.FS
+
+func TestEmbedFileCopy(t *testing.T) {
+ myConfigFS, err := testEmbedFiles.Open("test/zshrc-test-append-to-file.zshrc")
+ if err != nil {
+ t.Errorf("EmbedFileStringAppendToDest() error = %v", err)
+ }
+ type args struct {
+ dst string
+ src fs.File
+ }
+ tests := []struct {
+ name string
+ args args
+ wantErr bool
+ }{
+ {name: "TestEmbedFileCopy 1", args: args{
+ dst: "test/zshrc-test-copy-to-file.zshrc",
+ src: myConfigFS,
+ }},
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err := EmbedFileCopy(tt.args.dst, tt.args.src); (err != nil) != tt.wantErr {
+ t.Errorf("EmbedFileCopy() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+ t.Cleanup(func() {
+ if exists, err := Exists("test/zshrc-test-copy-to-file.zshrc"); err == nil && exists {
+ if err = os.Remove("test/zshrc-test-copy-to-file.zshrc"); err != nil {
+ t.Errorf("couldnt remove test file: %v", err)
+ }
+ }
+ })
+}
+
+func TestEmbedFileStringAppendToDest(t *testing.T) {
+ testConfig, err := testEmbedFiles.ReadFile("test/zshrc_test_extra.zsh")
+ if err != nil {
+ t.Errorf("EmbedFileStringAppendToDest() error = %v", err)
+ }
+ type args struct {
+ data []byte
+ dest string
+ }
+ tests := []struct {
+ name string
+ args args
+ wantErr bool
+ }{
+ {name: "TestEmbedFileStringAppendToDest 1", args: args{
+ data: testConfig,
+ dest: "test/zshrc-test-append-to-file.zshrc",
+ }},
+ {name: "TestEmbedFileStringAppendToDest 1", args: args{
+ data: testConfig,
+ dest: "test/copy-embed-file-test.zshrc",
+ }},
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err := EmbedFileStringAppendToDest(tt.args.data, tt.args.dest); (err != nil) != tt.wantErr {
+ t.Errorf("EmbedFileStringAppendToDest() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+ t.Cleanup(func() {
+ if exists, err := Exists("test/copy-embed-file-test.zshrc"); err == nil && exists {
+ if err = os.Remove("test/copy-embed-file-test.zshrc"); err != nil {
+ t.Errorf("couldnt remove test file: %v", err)
+ }
+ }
+ })
+}
+
+func TestDownloadAndInstallLatestVersionOfGolang(t *testing.T) {
+ dirs, err := NewDirectories()
+ if err != nil {
+ t.Errorf("failed to create Directories type: %v", err)
+ }
+ type args struct {
+ homeDir string
+ }
+ tests := []struct {
+ name string
+ args args
+ wantErr bool
+ }{
+ {name: "TestDownloadAndInstallLatestVersionOfGolang 1", args: args{homeDir: dirs.HomeDir}, wantErr: false},
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err := DownloadAndInstallLatestVersionOfGolang(tt.args.homeDir); (err != nil) != tt.wantErr {
+ t.Errorf("DownloadAndInstallLatestVersionOfGolang() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+}
+
+func TestSetVariableValue(t *testing.T) {
+ type args struct {
+ varName string
+ val string
+ osType string
+ configPath string
+ }
+ packages := &InstalledPackages{}
+ packages.BrewInstalledPackages = &BrewInstalled{
+ Names: []string{"bat"}, CaskFullNames: []string{"bat"}, Taps: []string{"bat"},
+ }
+ packages.AptInstalledPackages = &AptInstalled{Name: []string{"bat"}}
+
+ osType := runtime.GOOS
+ switch osType {
+ case "linux":
+ if err := RunCommandPipeOutput("sudo apt-get autoclean && sudo apt-get update"); err != nil {
+ t.Errorf("couldn't apt-get autocelan and update: %v", err)
+ }
+ if err := AptInstall(packages, "zsh", "apt-transport-https"); err != nil {
+ t.Errorf("couldn't install zsh via apt-get: %v", err)
+ }
+ case "darwin":
+ // ensure zsh is installed for unit tests
+ if err := BrewInstallProgram("zsh", "zsh", packages); err != nil {
+ t.Errorf("couldn't install zsh via homebrew: %v", err)
+ }
+ // ensure gnu-sed is installed for unit tests
+ if err := BrewInstallProgram("gnu-sed", "gsed", packages); err != nil {
+ t.Errorf("couldn't install gnu-sed via homebrew: %v", err)
+ }
+ }
+ zshrcTestTemplate, err := ResolveAbsPath("test/zshrc-test-template.zshrc")
+ if err != nil {
+ t.Errorf("Couldnt resolve zshrcTestTemplate path: %v", err)
+ }
+ tests := []struct {
+ name string
+ args args
+ wantErr bool
+ }{
+ {name: fmt.Sprintf("Test SetVariableValue %s 1", osType), args: args{
+ varName: "ZSH_THEME",
+ val: "powerlevel10k\\/powerlevel10k",
+ osType: osType,
+ configPath: zshrcTestTemplate,
+ }, wantErr: false},
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err := SetVariableValue(tt.args.varName, tt.args.val, tt.args.osType, tt.args.configPath); (err != nil) != tt.wantErr {
+ t.Errorf("SetVariableValue() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+}
+
func TestResolveAbsPath(t *testing.T) {
homedir, err := os.UserHomeDir()
if err != nil {
@@ -196,8 +357,12 @@ func TestBrewInstallCaskProgram(t *testing.T) {
brewName: "font-meslo-lg-nerd-font",
}, false},
}
+
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
+ if err := BrewTap("homebrew/cask-fonts", tt.args.packages); err != nil {
+ t.Errorf("BrewTap() error = %v, wantErr %v", err, tt.wantErr)
+ }
if err := BrewInstallCaskProgram(tt.args.brewName, tt.args.brewFullName, tt.args.packages); (err != nil) != tt.wantErr {
t.Errorf("BrewInstallCaskProgram() error = %v, wantErr %v", err, tt.wantErr)
}
@@ -380,7 +545,7 @@ func TestCopyStringToFile(t *testing.T) {
}{
{"Test CopyStringToFile 1", args{
data: "this is a test string to write to file",
- dest: "testWriteStringFile.txt",
+ dest: "test/testWriteStringFile.txt",
}, false},
{"Test CopyStringToFile 2 non-existent directory path", args{
data: "this is a test string to write to file",
@@ -394,6 +559,13 @@ func TestCopyStringToFile(t *testing.T) {
}
})
}
+ t.Cleanup(func() {
+ if exists, err := Exists("test/testWriteStringFile.txt"); err == nil && exists {
+ if err = os.Remove("test/testWriteStringFile.txt"); err != nil {
+ t.Errorf("couldnt remove test file: %v", err)
+ }
+ }
+ })
}
func TestCmdExec(t *testing.T) {
diff --git a/localio/test/zshrc-test-append-to-file.zshrc b/localio/test/zshrc-test-append-to-file.zshrc
new file mode 100644
index 0000000..146ed09
--- /dev/null
+++ b/localio/test/zshrc-test-append-to-file.zshrc
@@ -0,0 +1,18 @@
+# export PATH=$HOME/bin:/usr/local/bin:$PATH
+
+# Path to your oh-my-zsh installation.
+export ZSH=$HOME/.oh-my-zsh
+
+# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
+ZSH_THEME="robbyrussell"
+
+# Uncomment the following line to use case-sensitive completion.
+# CASE_SENSITIVE="true"
+
+plugins=(git)
+
+source $ZSH/oh-my-zsh.sh
+
+# User configuration
+
+# export MANPATH="/usr/local/man:$MANPATH"
diff --git a/localio/test/zshrc-test-single-line-plugin.zshrc b/localio/test/zshrc-test-single-line-plugin.zshrc
new file mode 100644
index 0000000..bf52fbf
--- /dev/null
+++ b/localio/test/zshrc-test-single-line-plugin.zshrc
@@ -0,0 +1,21 @@
+# export PATH=$HOME/bin:/usr/local/bin:$PATH
+
+# Path to your oh-my-zsh installation.
+export ZSH=$HOME/.oh-my-zsh
+
+# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
+ZSH_THEME="robbyrussell"
+
+# Uncomment the following line to use case-sensitive completion.
+# CASE_SENSITIVE="true"
+
+plugins=(git)
+
+source $ZSH/oh-my-zsh.sh
+
+# User configuration
+
+# export MANPATH="/usr/local/man:$MANPATH"
+
+# Example aliases
+# alias ohmyzsh="mate ~/.oh-my-zsh"
diff --git a/localio/test/zshrc-test-template-plugins.zshrc b/localio/test/zshrc-test-template-plugins.zshrc
new file mode 100644
index 0000000..23f205b
--- /dev/null
+++ b/localio/test/zshrc-test-template-plugins.zshrc
@@ -0,0 +1,38 @@
+# export PATH=$HOME/bin:/usr/local/bin:$PATH
+
+# Path to your oh-my-zsh installation.
+export ZSH=$HOME/.oh-my-zsh
+
+# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
+ZSH_THEME="robbyrussell"
+
+# Uncomment the following line to use case-sensitive completion.
+# CASE_SENSITIVE="true"
+
+plugins=(
+ git
+ tmux
+ fakename
+ cool-test
+ zsh-syntax-highlighting
+ zsh-autosuggestions
+ virtualenv
+ ansible
+ docker
+ docker-compose
+ terraform
+ fzf
+ another-plugin
+ someplugin
+ coolplugin
+ testing
+)
+
+source $ZSH/oh-my-zsh.sh
+
+# User configuration
+
+# export MANPATH="/usr/local/man:$MANPATH"
+
+# Example aliases
+# alias ohmyzsh="mate ~/.oh-my-zsh"
diff --git a/localio/test/zshrc-test-template.zshrc b/localio/test/zshrc-test-template.zshrc
new file mode 100644
index 0000000..fceb557
--- /dev/null
+++ b/localio/test/zshrc-test-template.zshrc
@@ -0,0 +1,23 @@
+# export PATH=$HOME/bin:/usr/local/bin:$PATH
+
+# Path to your oh-my-zsh installation.
+export ZSH=$HOME/.oh-my-zsh
+
+# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
+ZSH_THEME="robbyrussell"
+
+# Uncomment the following line to use case-sensitive completion.
+# CASE_SENSITIVE="true"
+
+plugins=(
+ git
+)
+
+source $ZSH/oh-my-zsh.sh
+
+# User configuration
+
+# export MANPATH="/usr/local/man:$MANPATH"
+
+# Example aliases
+# alias ohmyzsh="mate ~/.oh-my-zsh"
diff --git a/localio/test/zshrc_test_extra.zsh b/localio/test/zshrc_test_extra.zsh
new file mode 100644
index 0000000..c6b9742
--- /dev/null
+++ b/localio/test/zshrc_test_extra.zsh
@@ -0,0 +1,16 @@
+# Add ~/go/bin to path
+[[ ":$PATH:" != *":${HOME}/go/bin:"* ]] && export PATH="${PATH}:$HOME/go/bin"
+# Add gsed to path
+[[ ":$PATH:" != *":/usr/local/opt/gnu-sed/libexec/gnubin:" ]] && export PATH="${PATH}:/usr/local/opt/gnu-sed/libexec/gnubin"
+
+# Set GOPATH, GOROOT and add GOROOT to path
+if [[ -z "${GOPATH}" ]]; then export GOPATH="${HOME}/go"; fi
+if [[ -z "${GOROOT}" ]]; then export GOROOT="$(brew --prefix golang)/libexec"; fi
+if [[ ":$PATH:" != *":${GOROOT}/bin:"* ]] && export PATH="${PATH}:${GOROOT}/bin"
+
+# Set CTRL+U to only delete backwards to the left of the cursor.
+bindkey \^U backward-kill-line
+
+# To customize prompt, run `p10k configure` or edit ~/.p10k.zsh.
+[[ ! -f ~/.p10k.zsh ]] || source ~/.p10k.zsh
+POWERLEVEL9K_INSTANT_PROMPT=quiet
diff --git a/main.go b/main.go
index 58c7766..b8205d2 100644
--- a/main.go
+++ b/main.go
@@ -44,6 +44,9 @@ func pimpMyShell(osType string, dirs *localio.Directories, installedPackages *lo
""VXXXXXXXXXXXXXXXXXXV""`)
switch osType {
case "darwin":
+ if err := localio.BrewInstallProgram("ca-certificates", "ca-certificates", installedPackages); err != nil {
+ return err
+ }
if err := localio.BrewInstallProgram("zsh", "zsh", installedPackages); err != nil {
return err
}
@@ -52,12 +55,19 @@ func pimpMyShell(osType string, dirs *localio.Directories, installedPackages *lo
return err
}
case "linux":
- if err := localio.AptInstall(installedPackages, "zsh", "tilix"); err != nil {
+ if err := localio.RunCommandPipeOutput("sudo apt-get autoclean && sudo apt-get update"); err != nil {
+ return err
+ }
+ if err := localio.AptInstall(installedPackages, "zsh", "tilix", "apt-transport-https"); err != nil {
return err
}
if err := linux.CustomTilixBookmarks(); err != nil {
return err
}
+ // Install the latest version of golang
+ if err := localio.DownloadAndInstallLatestVersionOfGolang(dirs.HomeDir); err != nil {
+ return err
+ }
}
// install oh-my-zsh if not already installed
diff --git a/vim/vim.go b/vim/vim.go
index ea98102..c859e80 100644
--- a/vim/vim.go
+++ b/vim/vim.go
@@ -201,7 +201,6 @@ func InstallVimAwesome(osType string, dirs *localio.Directories, packages *local
"cmake",
"vim-nox",
"python3-dev",
- "golang",
"nodejs",
"default-jdk",
"npm",
diff --git a/vim/vim_test.go b/vim/vim_test.go
index 6f427d1..918afa2 100644
--- a/vim/vim_test.go
+++ b/vim/vim_test.go
@@ -3,6 +3,7 @@ package vim
import (
"pimp-my-shell/localio"
"testing"
+ "time"
)
func TestInstallVimPlugins(t *testing.T) {
@@ -28,12 +29,23 @@ func TestInstallVimPlugins(t *testing.T) {
dirs: dirs,
}, false},
}
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- if err := InstallVimPlugins(tt.args.osType, tt.args.dirs); (err != nil) != tt.wantErr {
- t.Errorf("InstallVimPlugins() error = %v, wantErr %v", err, tt.wantErr)
- }
- })
+ timeout := time.After(20 * time.Minute)
+ done := make(chan bool)
+ go func() {
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err := InstallVimPlugins(tt.args.osType, tt.args.dirs); (err != nil) != tt.wantErr {
+ t.Errorf("InstallVimPlugins() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+ done <- true
+ }()
+
+ select {
+ case <-timeout:
+ t.Fatal("Test didn't finish in time")
+ case <-done:
}
}
@@ -69,11 +81,21 @@ func TestInstallVimAwesome(t *testing.T) {
BrewInstalledPackages: nil,
}}, false},
}
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- if err := InstallVimAwesome(tt.args.osType, tt.args.dirs, tt.args.packages); (err != nil) != tt.wantErr {
- t.Errorf("InstallVimAwesome() error = %v, wantErr %v", err, tt.wantErr)
- }
- })
+ timeout := time.After(20 * time.Minute)
+ done := make(chan bool)
+ go func() {
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err := InstallVimAwesome(tt.args.osType, tt.args.dirs, tt.args.packages); (err != nil) != tt.wantErr {
+ t.Errorf("InstallVimAwesome() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+ done <- true
+ }()
+ select {
+ case <-timeout:
+ t.Fatal("Test didn't finish in time")
+ case <-done:
}
}
diff --git a/zsh/templates/darwin/zshrc_extra.zsh b/zsh/templates/darwin/zshrc_extra.zsh
index 51974c1..c6b9742 100644
--- a/zsh/templates/darwin/zshrc_extra.zsh
+++ b/zsh/templates/darwin/zshrc_extra.zsh
@@ -1,5 +1,12 @@
# Add ~/go/bin to path
-[[ ":$PATH:" != *":$HOME/go/bin:"* ]] && export PATH="${PATH}:$HOME/go/bin"
+[[ ":$PATH:" != *":${HOME}/go/bin:"* ]] && export PATH="${PATH}:$HOME/go/bin"
+# Add gsed to path
+[[ ":$PATH:" != *":/usr/local/opt/gnu-sed/libexec/gnubin:" ]] && export PATH="${PATH}:/usr/local/opt/gnu-sed/libexec/gnubin"
+
+# Set GOPATH, GOROOT and add GOROOT to path
+if [[ -z "${GOPATH}" ]]; then export GOPATH="${HOME}/go"; fi
+if [[ -z "${GOROOT}" ]]; then export GOROOT="$(brew --prefix golang)/libexec"; fi
+if [[ ":$PATH:" != *":${GOROOT}/bin:"* ]] && export PATH="${PATH}:${GOROOT}/bin"
# Set CTRL+U to only delete backwards to the left of the cursor.
bindkey \^U backward-kill-line
diff --git a/zsh/templates/linux/zshrc_extra.zsh b/zsh/templates/linux/zshrc_extra.zsh
index a143eba..d791323 100644
--- a/zsh/templates/linux/zshrc_extra.zsh
+++ b/zsh/templates/linux/zshrc_extra.zsh
@@ -1,7 +1,11 @@
-# Add ~/go/bin to path
-[[ ":$PATH:" != *":$HOME/go/bin:"* ]] && export PATH="${PATH}:$HOME/go/bin"
# For linux add ~/.local/bin to path
-[[ ":$PATH:" != *":$HOME/.locaal/bin:"* ]] && export PATH="${PATH}:$HOME/.local/bin"
+[[ ":$PATH:" != *":${HOME}/.locaal/bin:"* ]] && export PATH="${PATH}:${HOME}/.local/bin"
+
+# Add ~/go/bin to path
+[[ ":$PATH:" != *":${HOME}/go/bin:"* ]] && export PATH="${PATH}:${HOME}/go/bin"
+# Set GOPATH
+if [[ -z "${GOPATH}" ]]; then export GOPATH="${HOME}/go"; fi
+if [[ ":$PATH:" != *":/usr/local/go/bin:"* ]] && export PATH="${PATH}:/usr/local/go/bin"
# Set CTRL+U to only delete backwards to the left of the cursor.
bindkey \^U backward-kill-line
diff --git a/zsh/zsh.go b/zsh/zsh.go
index 00f0154..dfe4a98 100644
--- a/zsh/zsh.go
+++ b/zsh/zsh.go
@@ -9,15 +9,16 @@ import (
"pimp-my-shell/localio"
"pimp-my-shell/osrelease"
"regexp"
+ "sort"
"strings"
)
//go:embed templates/*
var zshConfigs embed.FS
-func updateZSHPlugins(dirs *localio.Directories) error {
+func updateZSHPlugins(zshrcPath string) error {
var re = regexp.MustCompile(`(?m)^plugins=\(\s*((?:[a-z][a-z0-9_-]+\s*)+)\)$`)
- input, err := ioutil.ReadFile(fmt.Sprintf("%s/.zshrc", dirs.HomeDir))
+ input, err := ioutil.ReadFile(zshrcPath)
if err != nil {
return err
}
@@ -31,12 +32,13 @@ func updateZSHPlugins(dirs *localio.Directories) error {
installedPlugins = append(installedPlugins, plugin)
}
}
+ sort.Strings(installedPlugins)
//fmt.Printf("InstalledPlugins: %+v\n", installedPlugins)
pluginsToAdd := strings.Join(installedPlugins, "\n\t")
updatedZshrcFile := re.ReplaceAllString(string(input), fmt.Sprintf("plugins=(\n\t%s\n)", pluginsToAdd))
- err = ioutil.WriteFile(fmt.Sprintf("%s/.zshrc", dirs.HomeDir), []byte(updatedZshrcFile), 0644)
+ err = ioutil.WriteFile(zshrcPath, []byte(updatedZshrcFile), 0644)
if err != nil {
return err
}
@@ -63,6 +65,9 @@ func InstallOhMyZsh(osType string, dirs *localio.Directories) error {
}
if exists, err = localio.Exists(fmt.Sprintf("%s/.zshrc", dirs.HomeDir)); err == nil && exists {
// Kali linux weird zshrc constraint
+ if exists, err = localio.Exists("/etc/os-release"); err == nil && !exists {
+ break
+ }
osINFO, err := osrelease.Read()
if err != nil {
return err
@@ -151,7 +156,7 @@ func InstallOhMyZsh(osType string, dirs *localio.Directories) error {
return err
}
- zshExtraConfigTemplate := fmt.Sprintf("templates/%s/zshrc_extra.zsh", osType)
+ zshExtraConfigTemplate := fmt.Sprintf("templates/%s/zshrc_test_extra.zsh", osType)
zshExtraConfig, err := zshConfigs.ReadFile(zshExtraConfigTemplate)
if err != nil {
return err
@@ -179,7 +184,7 @@ func InstallOhMyZsh(osType string, dirs *localio.Directories) error {
}
}
- if err = updateZSHPlugins(dirs); err != nil {
+ if err = updateZSHPlugins(fmt.Sprintf("%s/.zshrc", dirs.HomeDir)); err != nil {
return err
}
diff --git a/zsh/zsh_test.go b/zsh/zsh_test.go
index 661de0d..70ba369 100644
--- a/zsh/zsh_test.go
+++ b/zsh/zsh_test.go
@@ -1,10 +1,46 @@
package zsh
import (
+ "fmt"
"pimp-my-shell/localio"
+ "runtime"
"testing"
)
+// Test_updateZSHPlugins is a basic test checking for errors, it doesn't validate the correct plugins
+// were added yet...
+func Test_updateZSHPlugins(t *testing.T) {
+ zshrcTestTemplatePlugins, err := localio.ResolveAbsPath("test/zshrc-test-template-plugins.zshrc")
+ if err != nil {
+ t.Errorf("Couldnt resolve zshrcTestTemplatePlugins path: %v", err)
+ }
+ zshrcTestTemplateSingleLinePlugin, err := localio.ResolveAbsPath("test/zshrc-test-single-line-plugin.zshrc")
+ if err != nil {
+ t.Errorf("Couldnt resolve zshrcTestTemplateSingleLinePlugin path: %v", err)
+ }
+ type args struct {
+ zshrcPath string
+ }
+ tests := []struct {
+ name string
+ args args
+ wantErr bool
+ }{
+ {name: "Test_updateZSHPlugins Multi-line 1", args: args{zshrcTestTemplatePlugins}, wantErr: false},
+ {name: "Test_updateZSHPlugins Single-line 2", args: args{zshrcTestTemplateSingleLinePlugin}, wantErr: false},
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err = updateZSHPlugins(tt.args.zshrcPath); (err != nil) != tt.wantErr {
+ t.Errorf("updateZSHPlugins() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+ if err = localio.RunCommandPipeOutput(fmt.Sprintf("cat %s %s", zshrcTestTemplatePlugins, zshrcTestTemplateSingleLinePlugin)); err != nil {
+ t.Errorf("couldn't cat the files: %v", err)
+ }
+}
+
func TestInstallOhMyZsh(t *testing.T) {
dirs, err := localio.NewDirectories()
if err != nil {
@@ -14,6 +50,32 @@ func TestInstallOhMyZsh(t *testing.T) {
osType string
dirs *localio.Directories
}
+ packages := &localio.InstalledPackages{}
+ packages.BrewInstalledPackages = &localio.BrewInstalled{
+ Names: []string{"bat"}, CaskFullNames: []string{"bat"}, Taps: []string{"bat"},
+ }
+ packages.AptInstalledPackages = &localio.AptInstalled{Name: []string{"bat"}}
+
+ osType := runtime.GOOS
+ switch osType {
+ case "linux":
+ if err := localio.RunCommandPipeOutput("sudo apt-get autoclean && sudo apt-get update"); err != nil {
+ t.Errorf("couldn't apt-get autocelan and update: %v", err)
+ }
+ if err := localio.AptInstall(packages, "zsh", "apt-transport-https"); err != nil {
+ t.Errorf("couldn't install zsh via apt-get: %v", err)
+ }
+ case "darwin":
+ // ensure zsh is installed for unit tests
+ if err := localio.BrewInstallProgram("zsh", "zsh", packages); err != nil {
+ t.Errorf("couldn't install zsh via homebrew: %v", err)
+ }
+ // ensure gnu-sed is installed for unit tests
+ if err := localio.BrewInstallProgram("gnu-sed", "gsed", packages); err != nil {
+ t.Errorf("couldn't install gnu-sed via homebrew: %v", err)
+ }
+ }
+
tests := []struct {
name string
args args