diff options
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | LICENSE | 875 | ||||
-rw-r--r-- | PostInstall.txt | 7 | ||||
-rw-r--r-- | README.rdoc | 26 | ||||
-rwxr-xr-x | bin/ohai | 27 | ||||
-rw-r--r-- | features/development.feature | 13 | ||||
-rw-r--r-- | features/ohai.feature | 21 | ||||
-rw-r--r-- | features/steps/common.rb | 174 | ||||
-rw-r--r-- | features/steps/env.rb | 6 | ||||
-rw-r--r-- | lib/ohai.rb | 24 | ||||
-rw-r--r-- | lib/ohai/config.rb | 121 | ||||
-rw-r--r-- | lib/ohai/exception.rb | 26 | ||||
-rw-r--r-- | lib/ohai/log.rb | 92 | ||||
-rw-r--r-- | lib/ohai/log/formatter.rb | 60 | ||||
-rw-r--r-- | lib/ohai/mixin/command.rb | 198 | ||||
-rw-r--r-- | lib/ohai/mixin/from_file.rb | 39 | ||||
-rw-r--r-- | lib/ohai/plugins/architecture.rb | 41 | ||||
-rw-r--r-- | lib/ohai/plugins/kernel.rb | 23 | ||||
-rw-r--r-- | lib/ohai/plugins/lsb.rb | 41 | ||||
-rw-r--r-- | lib/ohai/plugins/os.rb | 65 | ||||
-rw-r--r-- | lib/ohai/system.rb | 135 | ||||
-rw-r--r-- | spec/ohai/log/log_formatter_spec.rb | 50 | ||||
-rw-r--r-- | spec/ohai/log_spec.rb | 66 | ||||
-rw-r--r-- | spec/ohai/mixin/from_file_spec.rb | 56 | ||||
-rw-r--r-- | spec/ohai/system_spec.rb | 128 | ||||
-rw-r--r-- | spec/ohai_spec.rb | 29 |
26 files changed, 2119 insertions, 226 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..cd9c569c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +pkg/ +tmp/ @@ -1,201 +1,674 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - -Copyright [yyyy] [name of copyright owner] - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + 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 <http://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<http://www.gnu.org/licenses/>. + + 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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/PostInstall.txt b/PostInstall.txt deleted file mode 100644 index 4d4dfaf1..00000000 --- a/PostInstall.txt +++ /dev/null @@ -1,7 +0,0 @@ - -For more information on ohai, see http://ohai.rubyforge.org - -NOTE: Change this information in PostInstall.txt -You can also delete it if you don't want it. - - diff --git a/README.rdoc b/README.rdoc index 2fc8fd4e..40d3686b 100644 --- a/README.rdoc +++ b/README.rdoc @@ -24,16 +24,22 @@ FIX (describe your package) == LICENSE: -Copyright (c) 2008 OpsCode, Inc. +Ohai - system information application -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at +Copyright (C) 2008, OpsCode Inc. - http://www.apache.org/licenses/LICENSE-2.0 +Portions of this program benefitted significantly from Facter, +primarily plugins. (http://reductivelabs.com/projects/facter/) -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License.
\ No newline at end of file +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 <http://www.gnu.org/licenses/>.
\ No newline at end of file @@ -18,17 +18,26 @@ # See the License for the specific language governing permissions and # limitations under the License. +$: << File.join(File.dirname(__FILE__), "..", "lib") require 'optparse' require 'rubygems' -#require 'ohai' +require 'ohai' require 'json' config = { + :directory => nil, + :file => nil, :kthxbye => false } opts = OptionParser.new do |opts| - opts.banner = "Usage: #{$0} [-d DIR|-r FILE] (options)" + opts.banner = "Usage: #{$0} (options)" + opts.on("-d", "--directory NAME", "A directory to add to the Ohai search path") do |d| + config[:directory] = d + end + opts.on("-f", "--file NAME", "A file to run Ohai against") do |f| + config[:file] = f + end opts.on("-k", "--kthxbye", "LOLcats") do |k| config[:kthxbye] = true end @@ -41,4 +50,16 @@ opts.parse!(ARGV) if config[:kthxbye] puts JSON.generate({ :lolcat => "http://icanhascheezburger.com/?random" }) -end
\ No newline at end of file +end + +ohai = Ohai::System.new +if config[:file] + ohai.from_file(config[:file]) +else + if config[:directory] + Ohai::Config[:plugin_path] << config[:directory] + end + ohai.all_plugins +end + +puts ohai.json_pretty_print diff --git a/features/development.feature b/features/development.feature new file mode 100644 index 00000000..9781acb2 --- /dev/null +++ b/features/development.feature @@ -0,0 +1,13 @@ +Feature: Development processes of newgem itself (rake tasks) + + As a Newgem maintainer or contributor + I want rake tasks to maintain and release the gem + So that I can spend time on the tests and code, and not excessive time on maintenance processes + + Scenario: Generate RubyGem + Given this project is active project folder + And 'pkg' folder is deleted + When task 'rake gem' is invoked + Then folder 'pkg' is created + And file with name matching 'pkg/*.gem' is created else you should run "rake manifest" to fix this + And gem spec key 'rdoc_options' contains /--mainREADME.rdoc/ diff --git a/features/ohai.feature b/features/ohai.feature new file mode 100644 index 00000000..48f25ba4 --- /dev/null +++ b/features/ohai.feature @@ -0,0 +1,21 @@ +Feature: Collects data about a system + In order to understand the state of my system + As a Systems Administrator + I want to have a program that detects information for me + + Scenario: Collect data about the system via a single plugin + Given a plugin called 'platform' + When I run ohai + Then I should have a 'platform' of 'kitties' + + Scenario: Collect data about the system via a directory of plugins + Given a plugin directory at './plugins' + When I run ohai + Then I should have a 'platform' of 'kitties' + And I should have a 'foghorn' of 'leghorn' + + Scenario: Collect data about the system via an external script + Given a plugin called 'perl' + When I run ohai + Then I should have a 'perl_major_version' of '5' +
\ No newline at end of file diff --git a/features/steps/common.rb b/features/steps/common.rb new file mode 100644 index 00000000..91cd2611 --- /dev/null +++ b/features/steps/common.rb @@ -0,0 +1,174 @@ +def in_project_folder(&block) + project_folder = @active_project_folder || @tmp_root + FileUtils.chdir(project_folder, &block) +end + +def in_home_folder(&block) + FileUtils.chdir(@home_path, &block) +end + +Given %r{^a safe folder} do + FileUtils.rm_rf @tmp_root = File.dirname(__FILE__) + "/../../tmp" + FileUtils.mkdir_p @tmp_root + FileUtils.mkdir_p @home_path = File.expand_path(File.join(@tmp_root, "home")) + @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib') + Given "env variable $HOME set to '#{@home_path}'" +end + +Given %r{^this project is active project folder} do + Given "a safe folder" + @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..") +end + +Given %r{^env variable \$([\w_]+) set to '(.*)'} do |env_var, value| + ENV[env_var] = value +end + +def force_local_lib_override(project_name = @project_name) + rakefile = File.read(File.join(project_name, 'Rakefile')) + File.open(File.join(project_name, 'Rakefile'), "w+") do |f| + f << "$:.unshift('#{@lib_path}')\n" + f << rakefile + end +end + +def setup_active_project_folder project_name + @active_project_folder = File.join(@tmp_root, project_name) + @project_name = project_name +end + +Given %r{'(.*)' folder is deleted} do |folder| + in_project_folder do + FileUtils.rm_rf folder + end +end + +When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments| + FileUtils.chdir(@active_project_folder) do + if Object.const_defined?("APP_ROOT") + APP_ROOT.replace(FileUtils.pwd) + else + APP_ROOT = FileUtils.pwd + end + run_generator(generator, arguments.split(' '), SOURCES) + end +end + +When %r{run executable '(.*)' with arguments '(.*)'} do |executable, arguments| + @stdout = File.expand_path(File.join(@tmp_root, "executable.out")) + FileUtils.chdir(@active_project_folder) do + system "ruby #{executable} #{arguments} > #{@stdout}" + end +end + +When %r{^task 'rake (.*)' is invoked$} do |task| + @stdout = File.expand_path(File.join(@tmp_root, "tests.out")) + FileUtils.chdir(@active_project_folder) do + system "rake #{task} --trace > #{@stdout} 2> #{@stdout}" + end +end + +Then %r{^folder '(.*)' is created} do |folder| + in_project_folder do + File.exists?(folder).should be_true + end +end + +Then %r{^file '(.*)' (is|is not) created} do |file, is| + in_project_folder do + File.exists?(file).should(is == 'is' ? be_true : be_false) + end +end + +Then %r{^file with name matching '(.*)' is created} do |pattern| + in_project_folder do + Dir[pattern].should_not be_empty + end +end + +Then %r{gem file '(.*)' and generated file '(.*)' should be the same} do |gem_file, project_file| + File.exists?(gem_file).should be_true + File.exists?(project_file).should be_true + gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}") + project_file_contents = File.read(File.join(@active_project_folder, project_file)) + project_file_contents.should == gem_file_contents +end + +Then %r{^output same as contents of '(.*)'$} do |file| + expected_output = File.read(File.join(File.dirname(__FILE__) + "/../expected_outputs", file)) + actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}") + actual_output.should == expected_output +end + +Then %r{^(does|does not) invoke generator '(.*)'$} do |does_invoke, generator| + actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}") + does_invoke == "does" ? + actual_output.should(match(/dependency\s+#{generator}/)) : + actual_output.should_not(match(/dependency\s+#{generator}/)) +end + +Then %r{help options '(.*)' and '(.*)' are displayed} do |opt1, opt2| + actual_output = File.read(@stdout) + actual_output.should match(/#{opt1}/) + actual_output.should match(/#{opt2}/) +end + +Then %r{^output (does|does not) match \/(.*)\/} do |does, regex| + actual_output = File.read(@stdout) + (does == 'does') ? + actual_output.should(match(/#{regex}/)) : + actual_output.should_not(match(/#{regex}/)) +end + +Then %r{^contents of file '(.*)' (does|does not) match \/(.*)\/} do |file, does, regex| + in_project_folder do + actual_output = File.read(file) + (does == 'does') ? + actual_output.should(match(/#{regex}/)) : + actual_output.should_not(match(/#{regex}/)) + end +end + +Then %r{^all (\d+) tests pass} do |expected_test_count| + expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors} + actual_output = File.read(@stdout) + actual_output.should match(expected) +end + +Then %r{^all (\d+) examples pass} do |expected_test_count| + expected = %r{^#{expected_test_count} examples?, 0 failures} + actual_output = File.read(@stdout) + actual_output.should match(expected) +end + +Then %r{^yaml file '(.*)' contains (\{.*\})} do |file, yaml| + in_project_folder do + yaml = eval yaml + YAML.load(File.read(file)).should == yaml + end +end + +Then %r{^Rakefile can display tasks successfully} do + @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out")) + FileUtils.chdir(@active_project_folder) do + system "rake -T > #{@stdout} 2> #{@stdout}" + end + actual_output = File.read(@stdout) + actual_output.should match(/^rake\s+\w+\s+#\s.*/) +end + +Then %r{^task 'rake (.*)' is executed successfully} do |task| + @stdout.should_not be_nil + actual_output = File.read(@stdout) + actual_output.should_not match(/^Don't know how to build task '#{task}'/) + actual_output.should_not match(/Error/i) +end + +Then %r{^gem spec key '(.*)' contains \/(.*)\/} do |key, regex| + in_project_folder do + gem_file = Dir["pkg/*.gem"].first + gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`) + spec_value = gem_spec.send(key.to_sym) + spec_value.to_s.should match(/#{regex}/) + end +end diff --git a/features/steps/env.rb b/features/steps/env.rb new file mode 100644 index 00000000..64d866ce --- /dev/null +++ b/features/steps/env.rb @@ -0,0 +1,6 @@ +require File.dirname(__FILE__) + "/../../lib/ohai" + +gem 'cucumber' +require 'cucumber' +gem 'rspec' +require 'spec' diff --git a/lib/ohai.rb b/lib/ohai.rb index 5f3fcada..a69005e7 100644 --- a/lib/ohai.rb +++ b/lib/ohai.rb @@ -1,6 +1,30 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__))) +require 'ohai/config' +require 'ohai/system' + module Ohai VERSION = '0.0.1' end
\ No newline at end of file diff --git a/lib/ohai/config.rb b/lib/ohai/config.rb new file mode 100644 index 00000000..7f9f899e --- /dev/null +++ b/lib/ohai/config.rb @@ -0,0 +1,121 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require 'ohai/mixin/from_file' + +# Ohai::Config[:variable] +# @config = Ohai::Config.new() +# Ohai::Config.from_file(foo) +# Ohai::Config[:cookbook_path] +# Ohai::Config.cookbook_path +# Ohai::Config.cookbook_path "one", "two" + +module Ohai + class Config + + @configuration = { + :log_level => :info, + :log_location => STDOUT, + :plugin_path => [ File.expand_path(File.join(File.dirname(__FILE__), 'plugins')) ] + } + + class << self + include Ohai::Mixin::FromFile + + # Pass Ohai::Config.configure() a block, and it will yield @configuration. + # + # === Parameters + # <block>:: A block that takes @configure as it's argument + def configure(&block) + yield @configuration + end + + # Get the value of a configuration option + # + # === Parameters + # config_option<Symbol>:: The configuration option to return + # + # === Returns + # value:: The value of the configuration option + # + # === Raises + # <ArgumentError>:: If the configuration option does not exist + def [](config_option) + if @configuration.has_key?(config_option.to_sym) + @configuration[config_option.to_sym] + else + raise ArgumentError, "Cannot find configuration option #{config_option.to_s}" + end + end + + # Set the value of a configuration option + # + # === Parameters + # config_option<Symbol>:: The configuration option to set (within the []) + # value:: The value for the configuration option + # + # === Returns + # value:: The new value of the configuration option + def []=(config_option, value) + @configuration[config_option.to_sym] = value + end + + # Check if Ohai::Config has a configuration option. + # + # === Parameters + # key<Symbol>:: The configuration option to check for + # + # === Returns + # <True>:: If the configuration option exists + # <False>:: If the configuration option does not exist + def has_key?(key) + @configuration.has_key?(key.to_sym) + end + + # Allows for simple lookups and setting of configuration options via method calls + # on Ohai::Config. If there any arguments to the method, they are used to set + # the value of the configuration option. Otherwise, it's a simple get operation. + # + # === Parameters + # method_symbol<Symbol>:: The method called. Must match a configuration option. + # *args:: Any arguments passed to the method + # + # === Returns + # value:: The value of the configuration option. + # + # === Raises + # <ArgumentError>:: If the method_symbol does not match a configuration option. + def method_missing(method_symbol, *args) + if @configuration.has_key?(method_symbol) + if args.length == 1 + @configuration[method_symbol] = args[0] + elsif args.length > 1 + @configuration[method_symbol] = args + end + return @configuration[method_symbol] + else + raise ArgumentError, "Cannot find configuration option #{method_symbol.to_s}" + end + end + + end # class << self + end +end diff --git a/lib/ohai/exception.rb b/lib/ohai/exception.rb new file mode 100644 index 00000000..2b26cfe5 --- /dev/null +++ b/lib/ohai/exception.rb @@ -0,0 +1,26 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +module Ohai + module Exception + class Exec < RuntimeError; end + end +end diff --git a/lib/ohai/log.rb b/lib/ohai/log.rb new file mode 100644 index 00000000..58be3746 --- /dev/null +++ b/lib/ohai/log.rb @@ -0,0 +1,92 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require 'ohai/config' +require 'ohai/log/formatter' +require 'logger' + +module Ohai + class Log + + @logger = nil + + class << self + attr_accessor :logger #:nodoc + + # Use Ohai::Logger.init when you want to set up the logger manually. Arguments to this method + # get passed directly to Logger.new, so check out the documentation for the standard Logger class + # to understand what to do here. + # + # If this method is called with no arguments, it will log to STDOUT at the :info level. + # + # It also configures the Logger instance it creates to use the custom Ohai::Log::Formatter class. + def init(*opts) + if opts.length == 0 + @logger = Logger.new(STDOUT) + else + @logger = Logger.new(*opts) + end + @logger.formatter = Ohai::Log::Formatter.new() + level(Ohai::Config.log_level) + end + + # Sets the level for the Logger object by symbol. Valid arguments are: + # + # :debug + # :info + # :warn + # :error + # :fatal + # + # Throws an ArgumentError if you feed it a bogus log level. + def level(loglevel) + init() unless @logger + case loglevel + when :debug + @logger.level = Logger::DEBUG + when :info + @logger.level = Logger::INFO + when :warn + @logger.level = Logger::WARN + when :error + @logger.level = Logger::ERROR + when :fatal + @logger.level = Logger::FATAL + else + raise ArgumentError, "Log level must be one of :debug, :info, :warn, :error, or :fatal" + end + end + + # Passes any other method calls on directly to the underlying Logger object created with init. If + # this method gets hit before a call to Ohai::Logger.init has been made, it will call + # Ohai::Logger.init() with no arguments. + def method_missing(method_symbol, *args) + init() unless @logger + if args.length > 0 + @logger.send(method_symbol, *args) + else + @logger.send(method_symbol) + end + end + + end # class << self + end +end
\ No newline at end of file diff --git a/lib/ohai/log/formatter.rb b/lib/ohai/log/formatter.rb new file mode 100644 index 00000000..7481ef23 --- /dev/null +++ b/lib/ohai/log/formatter.rb @@ -0,0 +1,60 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require 'logger' +require 'time' + +module Ohai + class Log + class Formatter < Logger::Formatter + @@show_time = true + + def self.show_time=(show=false) + @@show_time = show + end + + # Prints a log message as '[time] severity: message' if Ohai::Log::Formatter.show_time == true. + # Otherwise, doesn't print the time. + def call(severity, time, progname, msg) + if @@show_time + sprintf("[%s] %s: %s\n", time.rfc2822(), severity, msg2str(msg)) + else + sprintf("%s: %s\n", severity, msg2str(msg)) + end + end + + # Converts some argument to a Logger.severity() call to a string. Regular strings pass through like + # normal, Exceptions get formatted as "message (class)\nbacktrace", and other random stuff gets + # put through "object.inspect" + def msg2str(msg) + case msg + when ::String + msg + when ::Exception + "#{ msg.message } (#{ msg.class })\n" << + (msg.backtrace || []).join("\n") + else + msg.inspect + end + end + end + end +end
\ No newline at end of file diff --git a/lib/ohai/mixin/command.rb b/lib/ohai/mixin/command.rb new file mode 100644 index 00000000..85f9f896 --- /dev/null +++ b/lib/ohai/mixin/command.rb @@ -0,0 +1,198 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require 'ohai/exception' +require 'ohai/config' +require 'ohai/log' +require 'tmpdir' +require 'fcntl' +require 'etc' + +module Ohai + module Mixin + module Command + + def run_command(args={}) + if args.has_key?(:creates) + if File.exists?(args[:creates]) + Ohai::Log.debug("Skipping #{args[:command]} - creates #{args[:creates]} exists.") + return false + end + end + + stdout_string = nil + stderr_string = nil + + exec_processing_block = lambda do |pid, stdin, stdout, stderr| + stdin.close + + stdout_string = stdout.gets(nil) + if stdout_string + Ohai::Log.debug("---- Begin #{args[:command]} STDOUT ----") + Ohai::Log.debug(stdout_string.strip) + Ohai::Log.debug("---- End #{args[:command]} STDOUT ----") + end + stderr_string = stderr.gets(nil) + if stderr_string + Ohai::Log.debug("---- Begin #{args[:command]} STDERR ----") + Ohai::Log.debug(stderr_string.strip) + Ohai::Log.debug("---- End #{args[:command]} STDERR ----") + end + end + + args[:cwd] ||= Dir.tmpdir + unless File.directory?(args[:cwd]) + raise Ohai::Exception::Exec, "#{args[:cwd]} does not exist or is not a directory" + end + + status = nil + Dir.chdir(args[:cwd]) do + if args[:timeout] + begin + Timeout.timeout(args[:timeout]) do + status = popen4(args[:command], args, &exec_processing_block) + end + rescue Exception => e + Ohai::Log.error("#{args[:command_string]} exceeded timeout #{args[:timeout]}") + raise(e) + end + else + status = popen4(args[:command], args, &exec_processing_block) + end + + args[:returns] ||= 0 + if status.exitstatus != args[:returns] + raise Ohai::Exception::Exec, "#{args[:command_string]} returned #{status.exitstatus}, expected #{args[:returns]}" + else + Ohai::Log.debug("Ran #{args[:command_string]} (#{args[:command]}) returned #{status.exitstatus}") + end + end + return status, stdout_string, stderr_string + end + + module_function :run_command + + # This is taken directly from Ara T Howard's Open4 library, and then + # modified to suit the needs of Ohai. Any bugs here are most likely + # my own, and not Ara's. + # + # The original appears in external/open4.rb in it's unmodified form. + # + # Thanks, Ara. + def popen4(cmd, args={}, &b) + + args[:user] ||= nil + unless args[:user].kind_of?(Integer) + args[:user] = Etc.getpwnam(args[:user]).uid if args[:user] + end + args[:group] ||= nil + unless args[:group].kind_of?(Integer) + args[:group] = Etc.getgrnam(args[:group]).gid if args[:group] + end + args[:environment] ||= nil + + pw, pr, pe, ps = IO.pipe, IO.pipe, IO.pipe, IO.pipe + + verbose = $VERBOSE + begin + $VERBOSE = nil + ps.last.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) + + cid = fork { + pw.last.close + STDIN.reopen pw.first + pw.first.close + + pr.first.close + STDOUT.reopen pr.last + pr.last.close + + pe.first.close + STDERR.reopen pe.last + pe.last.close + + STDOUT.sync = STDERR.sync = true + + if args[:user] + Process.euid = args[:user] + Process.uid = args[:user] + end + + if args[:group] + Process.egid = args[:group] + Process.gid = args[:group] + end + + if args[:environment] + args[:environment].each do |key,value| + ENV[key] = value + end + end + + begin + if cmd.kind_of?(Array) + exec(*cmd) + else + exec(cmd) + end + raise 'forty-two' + rescue Exception => e + Marshal.dump(e, ps.last) + ps.last.flush + end + ps.last.close unless (ps.last.closed?) + exit! + } + ensure + $VERBOSE = verbose + end + + [pw.first, pr.last, pe.last, ps.last].each{|fd| fd.close} + + begin + e = Marshal.load ps.first + raise(Exception === e ? e : "unknown failure!") + rescue EOFError # If we get an EOF error, then the exec was successful + 42 + ensure + ps.first.close + end + + pw.last.sync = true + + pi = [pw.last, pr.first, pe.first] + + if b + begin + b[cid, *pi] + Process.waitpid2(cid).last + ensure + pi.each{|fd| fd.close unless fd.closed?} + end + else + [cid, pw.last, pr.first, pe.first] + end + end + + module_function :popen4 + end + end +end
\ No newline at end of file diff --git a/lib/ohai/mixin/from_file.rb b/lib/ohai/mixin/from_file.rb new file mode 100644 index 00000000..c55f18aa --- /dev/null +++ b/lib/ohai/mixin/from_file.rb @@ -0,0 +1,39 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +module Ohai + module Mixin + module FromFile + + # Loads a given ruby file, and runs instance_eval against it in the context of the current + # object. + # + # Raises an IOError if the file cannot be found, or is not readable. + def from_file(filename) + if File.exists?(filename) && File.readable?(filename) + self.instance_eval(IO.read(filename), filename, 1) + else + raise IOError, "Cannot open or read #{filename}!" + end + end + end + end +end diff --git a/lib/ohai/plugins/architecture.rb b/lib/ohai/plugins/architecture.rb new file mode 100644 index 00000000..eabcb5b8 --- /dev/null +++ b/lib/ohai/plugins/architecture.rb @@ -0,0 +1,41 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require_plugin "kernel" +require_plugin "os" + +hardware_model from('uname -m') + +case kernel +when "Linux" + case hardware_model + when 'x86_64' + if os == "Debian" + architecture "amd64" + else + architecture "x86_64" + end + when /(i[3456]86|pentium)/ + architecture "i386" + end +else + architecture hardware_model +end diff --git a/lib/ohai/plugins/kernel.rb b/lib/ohai/plugins/kernel.rb new file mode 100644 index 00000000..417d550f --- /dev/null +++ b/lib/ohai/plugins/kernel.rb @@ -0,0 +1,23 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +kernel from('uname -s') +kernel_release from('uname -r')
\ No newline at end of file diff --git a/lib/ohai/plugins/lsb.rb b/lib/ohai/plugins/lsb.rb new file mode 100644 index 00000000..a208e8dc --- /dev/null +++ b/lib/ohai/plugins/lsb.rb @@ -0,0 +1,41 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# Portions of this file benifited greatly from Facter +# (http://reductivelabs.com/projects/facter/) +# +# 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 <http://www.gnu.org/licenses/>. +# + +popen4("lsb_release -a") do |pid, stdin, stdout, stderr| + stdin.close + stdout.each do |line| + case line + when /^Distributor ID:\t(.*)$/ + lsb_dist_id $1 + when /^LSB Version:\t(.*)$/ + lsb_release $1 + when /^Release:\t(.*)$/ + lsb_dist_release $1 + when /^Description:\t(.*)$/ + lsb_dist_description $1 + when /^Codename:\t(.*)$/ + lsb_dist_codename $1 + end + end +end diff --git a/lib/ohai/plugins/os.rb b/lib/ohai/plugins/os.rb new file mode 100644 index 00000000..ef7b1bc2 --- /dev/null +++ b/lib/ohai/plugins/os.rb @@ -0,0 +1,65 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# Portions of this file benifited greatly from Facter +# (http://reductivelabs.com/projects/facter/) +# +# 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 <http://www.gnu.org/licenses/>. +# + +require_plugin 'kernel' +require_plugin 'lsb' + +if kernel == "SunOS" + os "Solaris" +elsif kernel == "Linux" + if lsb_dist_id == "Ubuntu" + os "Ubuntu" + os_release from_with_regex('cat /etc/issue', /Ubuntu (\d+.\d+)/) + elsif FileTest.exists?("/etc/debian_version") + os "Debian" + os_release from_with_regex('cat /proc/version', /\(Debian (\d+.\d+).\d+-\d+\)/) + elsif FileTest.exists?("/etc/gentoo-release") + os "Gentoo" + elsif FileTest.exists?("/etc/fedora-release") + os "Fedora" + os_release from_with_regex("cat /etc/fedora-release", /\((Rawhide)\)/, /release (\d+)/) + elsif FileTest.exists?("/etc/mandriva-release") + os "Mandriva" + elsif FileTest.exists?("/etc/mandrake-release") + os "Mandrake" + elsif FileTest.exists?("/etc/redhat-release") + txt = File.read("/etc/redhat-release") + if txt =~ /centos/i + os "CentOS" + os_release from_with_regex("rpm -q centos-release", /release-(\d+)/) + else + os "RedHat" + if txt =~ /\(Rawhide\)$/ + os_release "Rawhide" + elsif txt =~ /release (\d+)/ + os_release $1 + end + end + elsif FileTest.exists?("/etc/SuSE-release") + os "SuSE" + end +else + os kernel + os_release kernel_release +end diff --git a/lib/ohai/system.rb b/lib/ohai/system.rb new file mode 100644 index 00000000..ccc7d67d --- /dev/null +++ b/lib/ohai/system.rb @@ -0,0 +1,135 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require 'extlib' +require 'ohai/log' +require 'ohai/mixin/from_file' +require 'ohai/mixin/command' +require 'json' + +module Ohai + class System + attr_accessor :data, :seen_plugins + + include Ohai::Mixin::FromFile + include Ohai::Mixin::Command + + def initialize + @data = Mash.new + @seen_plugins = Hash.new + end + + def attribute?(name) + Ohai::Log.debug("Attribute #{name} is #{@data.has_key?(name)}") + @data.has_key?(name) + end + + def set(name, *value) + set_attribute(name, *value) + end + + def from(cmd) + status, stdout, stderr = run_command(:command => cmd) + stdout.chomp! + end + + # Set the value equal to the stdout of the command, plus run through a regex - the first piece of match data is the value. + def from_with_regex(cmd, *regex_list) + regex.flatten.each do |regex| + status, stdout, stderr = run_command(:command => cmd) + stdout.chomp! + md = stdout.match(regex) + return md[1] + end + end + + def set_attribute(name, *value) + Ohai::Log.debug("Setting attribute #{name} to #{value.inspect}") + @data[name] = *value + @data[name] + end + + def get_attribute(name) + Ohai::Log.debug("Getting attribute #{name}, value #{@data[name].inspect}") + @data[name] + end + + def all_plugins + Ohai::Config[:plugin_path].each do |path| + Dir[File.join(path, '**', '*')].each do |file| + file_regex = Regexp.new("#{path}#{File::SEPARATOR}(.+).rb$") + md = file_regex.match(file) + if md + plugin_name = md[1].gsub(File::SEPARATOR, "::") + require_plugin(plugin_name) unless @seen_plugins.has_key?(plugin_name) + end + end + end + end + + def require_plugin(plugin_name) + return true if @seen_plugins[plugin_name] + + filename = "#{plugin_name.gsub("::", File::SEPARATOR)}.rb" + + Ohai::Config[:plugin_path].each do |path| + check_path = File.expand_path(File.join(path, filename)) + begin + @seen_plugins[plugin_name] = true + Ohai::Log.info("Loading plugin #{plugin_name}") + from_file(check_path) + return true + rescue IOError => e + Ohai::Log.debug("No #{plugin_name} at #{check_path}") + rescue Exception => e + Ohai::Log.debug("Plugin #{plugin_name} threw exception #{e.inspect}") + end + end + end + + # Serialize this object as a hash + def to_json(*a) + output = @data.clone + output["json_class"] = self.class.name + output.to_json(*a) + end + + # Pretty Print this object as JSON + def json_pretty_print + JSON.pretty_generate(@data) + end + + # Create an Ohai::System from JSON + def self.json_create(o) + ohai = new + o.each do |key, value| + ohai.data[key] = value unless key == "json_class" + end + ohai + end + + def method_missing(name, *args) + return get_attribute(name) if args.length == 0 + + set_attribute(name, *args) + end + end +end
\ No newline at end of file diff --git a/spec/ohai/log/log_formatter_spec.rb b/spec/ohai/log/log_formatter_spec.rb new file mode 100644 index 00000000..56cc2b82 --- /dev/null +++ b/spec/ohai/log/log_formatter_spec.rb @@ -0,0 +1,50 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: Apache License, Version 2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +require 'time' +require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper")) + +describe Ohai::Log::Formatter do + before(:each) do + @formatter = Ohai::Log::Formatter.new + end + + it "should print raw strings with msg2str(string)" do + @formatter.msg2str("nuthin new").should == "nuthin new" + end + + it "should format exceptions properly with msg2str(e)" do + e = IOError.new("legendary roots crew") + @formatter.msg2str(e).should == "legendary roots crew (IOError)\n" + end + + it "should format random objects via inspect with msg2str(Object)" do + @formatter.msg2str([ "black thought", "?uestlove" ]).should == '["black thought", "?uestlove"]' + end + + it "should return a formatted string with call" do + time = Time.new + Ohai::Log::Formatter.show_time = true + @formatter.call("monkey", time, "test", "mos def").should == "[#{time.rfc2822}] monkey: mos def\n" + end + + it "should allow you to turn the time on and off in the output" do + Ohai::Log::Formatter.show_time = false + @formatter.call("monkey", Time.new, "test", "mos def").should == "monkey: mos def\n" + end +end
\ No newline at end of file diff --git a/spec/ohai/log_spec.rb b/spec/ohai/log_spec.rb new file mode 100644 index 00000000..5447bacc --- /dev/null +++ b/spec/ohai/log_spec.rb @@ -0,0 +1,66 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require 'tempfile' +require 'logger' + +require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper")) + +describe Ohai::Log do + it "should accept regular options to Logger.new via init" do + tf = Tempfile.new("chef-test-log") + tf.open + lambda { Ohai::Log.init(STDOUT) }.should_not raise_error + lambda { Ohai::Log.init(tf) }.should_not raise_error + end + + it "should set the log level with :debug, :info, :warn, :error, or :fatal" do + levels = { + :debug => Logger::DEBUG, + :info => Logger::INFO, + :warn => Logger::WARN, + :error => Logger::ERROR, + :fatal => Logger::FATAL + } + levels.each do |symbol, constant| + Ohai::Log.level(symbol) + Ohai::Log.logger.level.should == constant + end + end + + it "should raise an ArgumentError if you try and set the level to something strange" do + lambda { Ohai::Log.level(:the_roots) }.should raise_error(ArgumentError) + end + + it "should pass other method calls directly to logger" do + Ohai::Log.level(:debug) + Ohai::Log.should be_debug + lambda { Ohai::Log.debug("Gimme some sugar!") }.should_not raise_error + end + + it "should default to STDOUT if init is called with no arguments" do + logger_mock = mock(Logger, :null_object => true) + Logger.stub!(:new).and_return(logger_mock) + Logger.should_receive(:new).with(STDOUT).and_return(logger_mock) + Ohai::Log.init + end + +end
\ No newline at end of file diff --git a/spec/ohai/mixin/from_file_spec.rb b/spec/ohai/mixin/from_file_spec.rb new file mode 100644 index 00000000..5ce1ac4d --- /dev/null +++ b/spec/ohai/mixin/from_file_spec.rb @@ -0,0 +1,56 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require File.join(File.dirname(__FILE__), '..', '..', '/spec_helper.rb') + +describe Ohai::System, "from_file" do + before(:each) do + @ohai = Ohai::System.new + File.stub!(:exists?).and_return(true) + File.stub!(:readable?).and_return(true) + IO.stub!(:read).and_return("king 'herod'") + end + + it "should check to see that the file exists" do + File.should_receive(:exists?).and_return(true) + @ohai.from_file("/tmp/foo") + end + + it "should check to see that the file is readable" do + File.should_receive(:readable?).and_return(true) + @ohai.from_file("/tmp/foo") + end + + it "should actually read the file" do + IO.should_receive(:read).and_return("king 'herod'") + @ohai.from_file("/tmp/foo") + end + + it "should call instance_eval with the contents of the file, file name, and line 1" do + @ohai.should_receive(:instance_eval).with("king 'herod'", "/tmp/foo", 1) + @ohai.from_file("/tmp/foo") + end + + it "should raise an IOError if it cannot read the file" do + File.stub!(:exists?).and_return(false) + lambda { @ohai.from_file("/tmp/foo") }.should raise_error(IOError) + end +end diff --git a/spec/ohai/system_spec.rb b/spec/ohai/system_spec.rb new file mode 100644 index 00000000..ba4fc05b --- /dev/null +++ b/spec/ohai/system_spec.rb @@ -0,0 +1,128 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + +require File.join(File.dirname(__FILE__), '..', '/spec_helper.rb') + +describe Ohai::System, "initialize" do + it "should return an Ohai::System object" do + Ohai::System.new.should be_a_kind_of(Ohai::System) + end + + it "should set @data to a Mash" do + Ohai::System.new.data.should be_a_kind_of(Mash) + end + + it "should set @seen_plugins to a Hash" do + Ohai::System.new.seen_plugins.should be_a_kind_of(Hash) + end +end + +describe Ohai::System, "method_missing" do + before(:each) do + @ohai = Ohai::System.new + end + + it "should take a missing method and store the method name as a key, with it's arguments as values" do + @ohai.guns_n_roses("chinese democracy") + @ohai.data["guns_n_roses"].should eql("chinese democracy") + end + + it "should return the current value of the method name" do + @ohai.guns_n_roses("chinese democracy").should eql("chinese democracy") + end + + it "should allow you to get the value of a key by calling method_missing with no arguments" do + @ohai.guns_n_roses("chinese democracy") + @ohai.guns_n_roses.should eql("chinese democracy") + end +end + +describe Ohai::System, "attribute?" do + before(:each) do + @ohai = Ohai::System.new + @ohai.metallica("death magnetic") + end + + it "should return true if an attribute exists with the given name" do + @ohai.attribute?("metallica").should eql(true) + end + + it "should return false if an attribute does not exist with the given name" do + @ohai.attribute?("alice in chains").should eql(false) + end +end + +describe Ohai::System, "set_attribute" do + before(:each) do + @ohai = Ohai::System.new + end + + it "should let you set an attribute" do + @ohai.set_attribute(:tea, "is soothing") + @ohai.data["tea"].should eql("is soothing") + end +end + +describe Ohai::System, "get_attribute" do + before(:each) do + @ohai = Ohai::System.new + @ohai.set_attribute(:tea, "is soothing") + end + + it "should let you get an attribute" do + @ohai.get_attribute("tea").should eql("is soothing") + end +end + +describe Ohai::System, "require_plugin" do + before(:each) do + Ohai::Config[:plugin_path] = ["/tmp/plugins"] + File.stub!(:exists?).and_return(true) + @ohai = Ohai::System.new + @ohai.stub!(:from_file).and_return(true) + end + + it "should convert the name of the plugin to a file path" do + plugin_name = "foo::bar" + plugin_name.should_receive(:gsub).with("::", File::PATH_SEPARATOR) + @ohai.require_plugin(plugin_name) + end + + it "should check each part of the Ohai::Config[:plugin_path] for the plugin_filename.rb" do + @ohai.should_receive(:from_file).with("/tmp/plugins/foo.rb").and_return(true) + @ohai.require_plugin("foo") + end + + it "should add a found plugin to the list of seen plugins" do + @ohai.require_plugin("foo") + @ohai.seen_plugins["foo"].should eql(true) + end + + it "should return true if the plugin has been seen" do + @ohai.seen_plugins["foo"] = true + @ohai.require_plugin("foo") + end + + it "should return true if the plugin has been loaded" do + @ohai.require_plugin("foo").should eql(true) + end +end + diff --git a/spec/ohai_spec.rb b/spec/ohai_spec.rb index a52055a5..aa273e62 100644 --- a/spec/ohai_spec.rb +++ b/spec/ohai_spec.rb @@ -1,11 +1,30 @@ +# +# Author:: Adam Jacob (<adam@opscode.com>) +# Copyright:: Copyright (c) 2008 OpsCode, Inc. +# License:: GNU GPL, Version 3 +# +# Copyright (C) 2008, OpsCode Inc. +# +# 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 <http://www.gnu.org/licenses/>. +# + require File.dirname(__FILE__) + '/spec_helper.rb' -# Time to add your specs! -# http://rspec.info/ -describe "Place your specs here" do +describe Ohai do - it "find this spec in spec directory" do - violated "Be sure to write your specs" + it "should have a version constant defined" do + Ohai::VERSION.should be_a_kind_of(String) end end |