diff options
author | Darryl L. Pierce <dpierce@redhat.com> | 2008-08-04 16:20:22 -0400 |
---|---|---|
committer | Darryl L. Pierce <dpierce@redhat.com> | 2008-08-04 16:22:34 -0400 |
commit | f2d72cecc0ffb23af7a3b3f483d4c2de3cb0fe36 (patch) | |
tree | c31058eb77aad65c8d8e4c5f098b6ec966fbd878 /contrib | |
parent | e32078747922d51ed74452a039c0ff676c78ac58 (diff) | |
download | cobbler-f2d72cecc0ffb23af7a3b3f483d4c2de3cb0fe36.tar.gz cobbler-f2d72cecc0ffb23af7a3b3f483d4c2de3cb0fe36.tar.xz cobbler-f2d72cecc0ffb23af7a3b3f483d4c2de3cb0fe36.zip |
Ruby bindings for the Cobbler XMLRCP interface.
This first pass is very simple, only wrapping the Distro, Profile and
System objects and the NetworkInterface type. All classes extended a
class named Base, and all are in the Cobbler module.
Configuration is held within the config/cobbler.yml file, but can be
overridden at runtime.
Unit tests, examples, etc. are also provided.
Diffstat (limited to 'contrib')
25 files changed, 2205 insertions, 0 deletions
diff --git a/contrib/ruby/COPYING b/contrib/ruby/COPYING new file mode 100644 index 00000000..cf9b6b99 --- /dev/null +++ b/contrib/ruby/COPYING @@ -0,0 +1,510 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. +^L + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. +^L + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control +compilation and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. +^L + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. +^L + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. +^L + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. +^L + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply, and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License +may add an explicit geographical distribution limitation excluding those +countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. +^L + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS +^L + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +It is safest to attach them to the start of each source file to most +effectively convey 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 library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/contrib/ruby/NEWS b/contrib/ruby/NEWS new file mode 100644 index 00000000..701d515a --- /dev/null +++ b/contrib/ruby/NEWS @@ -0,0 +1,2 @@ +2008-08-01 0.0.1 + * Initial release.
\ No newline at end of file diff --git a/contrib/ruby/README b/contrib/ruby/README new file mode 100644 index 00000000..0fda7e22 --- /dev/null +++ b/contrib/ruby/README @@ -0,0 +1,29 @@ +ruby-cobbler +============ + +Ruby bindings for interacting with Cobbler. + + +USAGE +----- + +To include the code, you must install the ruby gem named "cobbler" and then +require 'cobbler' in your application. + +Minimally you need to provide a server name for your Cobbler machine using: + +Cobbler::Base.hostname = my.cobbler.server + +If you intend to modify data on the Cobbler server, you'll need to also provide +a username and password that has authorization: + +Cobbler::Base.username = username +Cobbler::Base.password = password + +CONFIGURATION +------------- + +By default, Cobbler::Base will load the file config/cobbler.yml, if it exists, +and use that information for talking to Cobbler. To override where this file +lives, set the COBBLER_ENV environment variable *before* requiring the 'cobbler' +file.
\ No newline at end of file diff --git a/contrib/ruby/Rakefile b/contrib/ruby/Rakefile new file mode 100644 index 00000000..994a2d82 --- /dev/null +++ b/contrib/ruby/Rakefile @@ -0,0 +1,61 @@ +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +require 'rake/clean' +require 'rake/rdoctask' +require 'rake/testtask' +require 'rake/gempackagetask' + +PKG_NAME='rubygem-cobbler' +PKG_VERSION='0.0.1' +PKG_FILES=FileList[ + 'Rakefile', 'README', 'COPYING', 'NEWS', + 'lib/**/*.rb', + 'examples/**/*.rb', + 'config/*', + 'test/**/*.rb' +] +SPEC_FILE='#{PKG_NAME}.spec' + +SPEC = Gem::Specification.new do |s| + s.name = 'cobbler' + s.version = PKG_VERSION + s.author = 'Darryl L. Pierce' + s.email = 'dpierce@redhat.com' + s.homepage = 'http://cobbler.et.redhat.com/' + s.platform = Gem::Platform::RUBY + s.summary = 'An interface for interacting with a Cobbler server.' + s.files = PKG_FILES + s.require_path = "." + s.autorequire = "cobbler" + s.description = <<EOF + Provides Ruby bindings to interact with a Cobbler server. +EOF +end + +Rake::TestTask.new(:test) do |t| + t.test_files = FileList['test/*.rb'] + t.libs = [ 'lib' ] +end + +Rake::GemPackageTask.new(SPEC) do |pkg| + pkg.need_tar = true + pkg.need_zip = true +end + +CLEAN.include [ "pkg" ] diff --git a/contrib/ruby/config/cobbler.yml b/contrib/ruby/config/cobbler.yml new file mode 100644 index 00000000..2cc2b722 --- /dev/null +++ b/contrib/ruby/config/cobbler.yml @@ -0,0 +1,5 @@ +# Cobbler connection details + +hostname: my.cobbler.server.com +username: admin +password: farkle diff --git a/contrib/ruby/examples/create_system.rb b/contrib/ruby/examples/create_system.rb new file mode 100644 index 00000000..0196573c --- /dev/null +++ b/contrib/ruby/examples/create_system.rb @@ -0,0 +1,77 @@ +#!/usr/bin/ruby -w +# +# create_system.rb - example of using rubygem-cobbler to create a system. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--name", "-n", GetoptLong::REQUIRED_ARGUMENT ], + ["--profile", "-f", GetoptLong::REQUIRED_ARGUMENT ], + ["--system", "-y", GetoptLong::REQUIRED_ARGUMENT ], + ["--username", "-u", GetoptLong::REQUIRED_ARGUMENT ], + ["--password", "-p", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = name = profile = system = username = password = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--name' then name = arg + when '--system' then system = arg + when '--profile' then profile = arg + when '--username' then username = arg + when '--password' then password = arg + when '--help' then usage + end +end + +def usage + puts "Usage: #{$0} [--server hostname] --name system-name --system system-name [--username username] [--password password]\n" +end + +if name && profile + + system = System.new('name' => name,'profile' => profile) + + system.interfaces=[ NetworkInterface.new('mac_address' => '00:11:22:33:44:55:66:77') ] + + puts "Saving a new system with name #{system.name} based on the profile #{system.profile}." + + begin + system.save + puts "Successfully saved the new system." + rescue Exception => error + puts "Unable to create system: #{error.message}" + end +else + usage +end
\ No newline at end of file diff --git a/contrib/ruby/examples/has_distro.rb b/contrib/ruby/examples/has_distro.rb new file mode 100644 index 00000000..22093d72 --- /dev/null +++ b/contrib/ruby/examples/has_distro.rb @@ -0,0 +1,66 @@ +#!/usr/bin/ruby +# +# has_distro.rb - example of using rubygem-cobbler to check if a distro exists. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierceredhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--distro", "-t", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil +distro = nil +find_all = true + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--distro' then distro = arg + when '--help' then + puts "Usage: #{$0} --server hostname --distro distro-name\n" + end +end + +SystemExit.new('No hostname specified.') unless hostname + +if hostname && distro + Distro.hostname = hostname + + puts "Finding any distro that matches \"#{distro}\"" + + result = Distro.find_one(distro) + + if result + puts "#{result.name} exists, and is a breed of #{result.breed}." + else + puts "No such system: #{distro}" + end +end
\ No newline at end of file diff --git a/contrib/ruby/examples/has_profile.rb b/contrib/ruby/examples/has_profile.rb new file mode 100644 index 00000000..401a6c1c --- /dev/null +++ b/contrib/ruby/examples/has_profile.rb @@ -0,0 +1,65 @@ +#!/usr/bin/ruby +# +# has_profile.rb - example of using rubygem-cobbler to chekc if a profile exists. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--profile", "-t", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil +profile = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--profile' then profile = arg + when '--help' then + puts "Usage: #{$0} --server hostname --system system-name\n" + end +end + +SystemExit.new('No hostname specified.') unless hostname + +if hostname + Profile.hostname = hostname + + puts "Finding any system that matches \"#{profile}\"" + + result = Profile.find_one(profile) + + if result + puts "#{result.name} exists, and is owned by #{result.owners}." + else + puts "No such system: #{profile}" + end +end
\ No newline at end of file diff --git a/contrib/ruby/examples/has_system.rb b/contrib/ruby/examples/has_system.rb new file mode 100644 index 00000000..9088666d --- /dev/null +++ b/contrib/ruby/examples/has_system.rb @@ -0,0 +1,65 @@ +#!/usr/bin/ruby +# +# has_system.rb - example of using rubygem-cobbler to check if a system exists. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierceredhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--system", "-t", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil +system = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--system' then system = arg + when '--help' then + puts "Usage: #{$0} --server hostname --system system-name\n" + end +end + +SystemExit.new('No hostname specified.') unless hostname + +if hostname + Base.hostname = hostname + + puts "Finding any system that matches \"#{system}\"" + + result = System.find_one(system) + + if result + puts "#{result.name} exists, and is owned by #{result.owners}." + else + puts "No such system: #{system}" + end +end
\ No newline at end of file diff --git a/contrib/ruby/examples/list_distros.rb b/contrib/ruby/examples/list_distros.rb new file mode 100644 index 00000000..27dcd0a9 --- /dev/null +++ b/contrib/ruby/examples/list_distros.rb @@ -0,0 +1,52 @@ +#!/usr/bin/ruby +# list_distros.rb - example of using rubygem-cobbler to list distros. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--help' then + puts "Usage: #{$0} --server hostname\n" + end +end + +if hostname + Distro.hostname = hostname + + puts "Results:" + Distro.find { |distro| puts "\"#{distro.name}\" is a breed of \"#{distro.breed}\"."} +end
\ No newline at end of file diff --git a/contrib/ruby/examples/list_profiles.rb b/contrib/ruby/examples/list_profiles.rb new file mode 100644 index 00000000..3ca97c50 --- /dev/null +++ b/contrib/ruby/examples/list_profiles.rb @@ -0,0 +1,53 @@ +#!/usr/bin/ruby +# +# list_profiles.rb - example of using rubygem-cobbler to list profiles. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--help' then + puts "Usage: #{$0} --server hostname\n" + end +end + +if hostname + Profile.hostname = hostname + + puts "Results:" + Profile.find { |profile| puts "\"#{profile.name}\" is based on \"#{profile.distro}\"."} +end
\ No newline at end of file diff --git a/contrib/ruby/examples/list_systems.rb b/contrib/ruby/examples/list_systems.rb new file mode 100644 index 00000000..d614460f --- /dev/null +++ b/contrib/ruby/examples/list_systems.rb @@ -0,0 +1,52 @@ +#!/usr/bin/ruby +# +# list_systems.rb - example of using rubygem-cobbler to list system. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--help' then + puts "Usage: #{$0} --server hostname\n" + end +end + + +Base.hostname = hostname if hostname + +puts "Results:" +System.find { |system| puts "\"#{system.name}\" is based on \"#{system.profile}\"."} diff --git a/contrib/ruby/examples/remove_distro.rb b/contrib/ruby/examples/remove_distro.rb new file mode 100644 index 00000000..d4e34adc --- /dev/null +++ b/contrib/ruby/examples/remove_distro.rb @@ -0,0 +1,71 @@ +#!/usr/bin/ruby +# +# remove_system.rb - example of using rubygem-cobbler to remove a system. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierceredhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--distro", "-d", GetoptLong::REQUIRED_ARGUMENT ], + ["--username", "-u", GetoptLong::REQUIRED_ARGUMENT ], + ["--password", "-p", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil +distro = nil +username = nil +password = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--distro' then distro = arg + when '--username' then username = arg + when '--password' then password = arg + when '--help' then + puts "Usage: #{$0} --server hostname --distro distro-name --username username --password password\n" + end +end + +SystemExit.new('No hostname specified.') unless hostname + +if hostname && distro && username && password + System.hostname = hostname + System.username = username + System.password = password + + puts "Removing \"#{distro}\"..." + + begin + puts "Deleted \"#{distro}" if System.remove(distro) + rescue Exception => e + puts "Error: #{e.message}" + end +end
\ No newline at end of file diff --git a/contrib/ruby/examples/remove_system.rb b/contrib/ruby/examples/remove_system.rb new file mode 100644 index 00000000..d592165a --- /dev/null +++ b/contrib/ruby/examples/remove_system.rb @@ -0,0 +1,71 @@ +#!/usr/bin/ruby +# +# remove_system.rb - example of using rubygem-cobbler to remove a system. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierceredhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +base = File.expand_path(File.join(File.dirname(__FILE__), "..")) +$LOAD_PATH << File.join(base, "lib") +$LOAD_PATH << File.join(base, "examples") + +require 'getoptlong' + +require 'cobbler' + +include Cobbler + +opts = GetoptLong.new( + ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT ], + ["--system", "-t", GetoptLong::REQUIRED_ARGUMENT ], + ["--username", "-u", GetoptLong::REQUIRED_ARGUMENT ], + ["--password", "-p", GetoptLong::REQUIRED_ARGUMENT ], + ["--help", "-h", GetoptLong::NO_ARGUMENT] +) + +hostname = nil +system = nil +username = nil +password = nil + +opts.each do |opt, arg| + case opt + when '--server' then hostname = arg + when '--system' then system = arg + when '--username' then username = arg + when '--password' then password = arg + when '--help' then + puts "Usage: #{$0} --server hostname --system system-name\n" + end +end + +SystemExit.new('No hostname specified.') unless hostname + +if hostname && system && username && password + System.hostname = hostname + System.username = username + System.password = password + + puts "Removing \"#{system}\"..." + + begin + puts "Deleted \"#{system}" if System.remove(system) + rescue Exception => e + puts "Error: #{e.message}" + end +end
\ No newline at end of file diff --git a/contrib/ruby/lib/cobbler.rb b/contrib/ruby/lib/cobbler.rb new file mode 100644 index 00000000..379d746f --- /dev/null +++ b/contrib/ruby/lib/cobbler.rb @@ -0,0 +1,38 @@ +# cobbler.rb - Cobbler module declaration. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +require 'cobbler/base' +require 'cobbler/distro' +require 'cobbler/network_interface' +require 'cobbler/profile' +require 'cobbler/system' + +module Cobbler + config = (ENV['COBBLER_YML'] || File.expand_path("config/cobbler.yml")) + + yml = YAML::load(File.open(config)) if File.exist?(config) + + if yml + Base.hostname = yml['hostname'] + Base.username = yml['username'] + Base.password = yml['password'] + end + +end diff --git a/contrib/ruby/lib/cobbler/base.rb b/contrib/ruby/lib/cobbler/base.rb new file mode 100644 index 00000000..bbd7263d --- /dev/null +++ b/contrib/ruby/lib/cobbler/base.rb @@ -0,0 +1,261 @@ +# base.rb +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +require 'xmlrpc/client' +require 'pp' +require 'yaml' + +module Cobbler + include XMLRPC + + # +Base+ represents a remote Cobbler server. + # + # Child classes can define fields that will be retrieved from Cobbler by + # using the +cobbler_field+ method. For example: + # + # class Farkle < Base + # cobbler_field :name, findable => 'get_farkle' + # cobbler_field :owner + # end + # + # declares a class named Farkle that contains two fields. The first, "name", + # will be one that is searchable on Cobbler; i.e., a method named "find_by_name" + # will be generated and will use the "get_farkle" remote method to retrieve + # that instance from Cobbler. + # + # The second field, "owner", will simply be a field named Farkle.owner that + # returns a character string. + # + # +Base+ provides some common functionality for all child classes: + # + # + class Base + + @@hostname = nil + @@connection = nil + + @defintions = nil + + def initialize(definitions) + @definitions = definitions + end + + # Sets the connection. This method is only needed during unit testing. + # + def self.connection=(mock) + @@connection = mock + end + + # Returns or creates a new connection. + # + def self.connect(writable) + @@connection || XMLRPC::Client.new2("http://#{@@hostname}/cobbler_api#{writable ? '_rw' : ''}") + end + + # Establishes a connection with the Cobbler system. + # + def self.begin_transaction(writable = false) + @@connection = connect(writable) + end + + # Sets the username. + # + def self.username=(username) + @@username = username + end + + # Sets the password. + # + def self.password=(password) + @@password = password + end + + # Logs into the Cobbler server. + # + def self.login + make_call('login', @@username, @@password) + end + + # Makes a remote call. + # + def self.make_call(*args) + raise Exception.new('No exception established.') unless @@connection + + @@connection.call(*args) + end + + # Ends a transaction and disconnects. + # + def self.end_transaction + @@connection = nil + end + + def definition(key) + @definitions ? @definitions[key] : nil + end + + def store_definition(key,value) + @definitions[key] = value + end + + def definitions + @definitions + end + + def self.hostname=(hostname) + @@hostname = hostname + end + + class << self + # Creates a complete finder method + # + def cobbler_lifecycle(*args) + methods = args.first + methods.keys.each do |key| + + method = methods[key] + + case key + when :find_all then + module_eval <<-"end;" + def self.find(&block) + begin + begin_transaction + records = make_call('#{method}') + ensure + end_transaction + end + + result = Array.new + + if records + records.each { |record| result << create(record) } + end + + result.each { |system| yield(system) } if block + + return result + end + end; + + when :find_one then + module_eval <<-"end;" + def self.find_one(name, flatten = false) + begin + begin_transaction + record = make_call('#{method}',name,flatten) + ensure + end_transaction + end + + return create(record) unless record.keys.empty? + + return nil + end + end; + + when :remove then + module_eval <<-"end;" + def self.remove(name) + begin + begin_transaction(true) + token = login + result = make_call('#{method}',name,token) + ensure + end_transaction + end + + result + end + end; + + end + end + end + + # Allows for dynamically declaring fields that will come from + # Cobbler. + # + def cobbler_field(field,*args) # :nodoc: + + defined = false + + if args + for arg in args + for key in arg.keys + case key + when :findable then + + module_eval <<-"end;" + def self.find_by_#{field.to_s}(name,&block) + properties = make_call('#{arg[key]}',name) + + return create(properties) if properties && !properties.empty? + + return nil + end + end; + + end + end + end + end + + module_eval <<-"end;" + def #{field.to_s}(&block) + return definition('#{field.to_s}') + end + + def #{field.to_s}=(value) + store_definition('#{field.to_s}',value) + end + end; + end + + # Allows a field to be defined as a collection of objects. The type for that + # other class must be provided. + # + def cobbler_collection(field, *args) # :nodoc: + classname = args[0][:type] + + module_eval <<-"end;" + def #{field.to_s}(&block) + unless @#{field.to_s} + @#{field.to_s} = Array.new + + definition('#{field.to_s}').values.each do |value| + @#{field.to_s} << #{classname}.new(value) + end + + end + + @#{field.to_s} + + end + + def #{field.to_s}=(replacement) + @#{field.to_s} = replacement + end + end; + + end + end + end +end
\ No newline at end of file diff --git a/contrib/ruby/lib/cobbler/distro.rb b/contrib/ruby/lib/cobbler/distro.rb new file mode 100644 index 00000000..c66d29d7 --- /dev/null +++ b/contrib/ruby/lib/cobbler/distro.rb @@ -0,0 +1,54 @@ +# distro.rb +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +module Cobbler + + # +Distro+ represents a single distrobution within Cobbler. + # + class Distro < Base + cobbler_lifecycle :find_all => 'get_distros', + :find_one => 'get_distro', + :remove => 'remove_distro' + + cobbler_field :name + cobbler_field :owners + cobbler_field :kernel + cobbler_field :breed + cobbler_field :depth + cobbler_field :arch + cobbler_field :initrd + cobbler_field :source_repos + cobbler_field :kernel_options + cobbler_field :parent + cobbler_field :ks_meta + + def initialize(definitions) + super(definitions) + end + + private + + # Creates a new instance of +Profile+ from a result received from Cobbler. + # + def self.create(attrs) + Distro.new(attrs) + end + end +end diff --git a/contrib/ruby/lib/cobbler/network_interface.rb b/contrib/ruby/lib/cobbler/network_interface.rb new file mode 100644 index 00000000..5ef4a3b0 --- /dev/null +++ b/contrib/ruby/lib/cobbler/network_interface.rb @@ -0,0 +1,53 @@ +# distro.rb +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +module Cobbler + # +NetworkInterface+ represents a single network interface card on a system. + # + class NetworkInterface < Base + cobbler_field :dhcp_tag + cobbler_field :mac_address + cobbler_field :subnet + cobbler_field :gateway + cobbler_field :hostname + cobbler_field :virt_bridge + cobbler_field :ip_address + + def initialize(definitions) + @definitions = definitions + end + + # A hack for getting the NIC's details over the wire. + # + def bundle_for_saving(which) + result = Hash.new + + result["macaddress-intf#{which}"] = mac_address if mac_address + result["ipaddress-intf#{which}"] = ip_address if ip_address + result["hostname-intf#{which}"] = hostname if hostname + result["virtbridge-intf#{which}"] = virt_bridge if virt_bridge + result["dhcptag-intf#{which}"] = dhcp_tag if dhcp_tag + result["subnet-intf#{which}"] = subnet if subnet + result["gateway-intf#{which}"] = gateway if gateway + + return result + end + end +end diff --git a/contrib/ruby/lib/cobbler/profile.rb b/contrib/ruby/lib/cobbler/profile.rb new file mode 100644 index 00000000..c8df8a33 --- /dev/null +++ b/contrib/ruby/lib/cobbler/profile.rb @@ -0,0 +1,62 @@ +# profile.rb +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +# +Profile+ represents a single profile. +# +module Cobbler + + # +Profile+ represents a single profile within Cobbler. + # + class Profile < Base + cobbler_lifecycle :find_all => 'get_profiles', + :find_one => 'get_profile', + :remove => 'remove_profile' + + cobbler_field :name, :findable => 'get_profile' + cobbler_field :parent + cobbler_field :owners + cobbler_field :dhcp_tag + cobbler_field :depth + cobbler_field :virt_file_size + cobbler_field :virt_path + cobbler_field :virt_type + cobbler_field :repos + cobbler_field :distro + cobbler_field :server + cobbler_field :virt_bridge + cobbler_field :virt_ram + cobbler_field :kernel_options + cobbler_field :virt_cpus + cobbler_field :ks_meta + cobbler_field :kickstart + + def initialize(definitions) + super(definitions) + end + + private + + # Creates a new instance of +Profile+ from a result received from Cobbler. + # + def self.create(attrs) + Profile.new(attrs) + end + end +end diff --git a/contrib/ruby/lib/cobbler/system.rb b/contrib/ruby/lib/cobbler/system.rb new file mode 100644 index 00000000..acfa3f54 --- /dev/null +++ b/contrib/ruby/lib/cobbler/system.rb @@ -0,0 +1,92 @@ +# system.rb +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +module Cobbler + + # +System+ represents a system within Cobbler. + # + class System < Base + + cobbler_lifecycle :find_all => 'get_systems', + :find_one => 'get_system', + :remove => 'remove_system' + + cobbler_field :name + cobbler_field :parent + cobbler_field :profile + cobbler_field :depth + cobbler_field :kernel_options + cobbler_field :kickstart + cobbler_field :ks_meta + cobbler_field :netboot_enabled + cobbler_field :owners + cobbler_field :server + cobbler_field :virt_cpus + cobbler_field :virt_file_size + cobbler_field :virt_path + cobbler_field :virt_ram + cobbler_field :virt_type + cobbler_field :virt_bridge + + cobbler_collection :interfaces, :type => 'NetworkInterface' + + def initialize(definitions) + super(definitions) + end + + # Saves this instance. + # + def save + Base.begin_transaction(true) + + token = Base.login + sysid = Base.make_call('new_system',token) + + Base.make_call('modify_system',sysid,'name',self.name,token) + Base.make_call('modify_system',sysid,'profile',profile,token) + + unless interfaces.empty? + count = 0 + interfaces.each do |interface| + + values = interface.bundle_for_saving(count) + + unless values.empty? + Base.make_call('modify_system',sysid,'modify-interface',values,token) + count = count + 1 + end + + end + end + + Base.make_call('save_system',sysid,token) + + Base.end_transaction + end + + private + + # Creates a new instance of +System+ from a result received from Cobbler. + # + def self.create(attrs) + System.new(attrs) + end + end +end
\ No newline at end of file diff --git a/contrib/ruby/rubygem-cobbler.spec b/contrib/ruby/rubygem-cobbler.spec new file mode 100644 index 00000000..e70e4f75 --- /dev/null +++ b/contrib/ruby/rubygem-cobbler.spec @@ -0,0 +1,56 @@ +# Generated from cobbler-0.0.1.gem by gem2rpm -*- rpm-spec -*- +%define ruby_sitelib %(ruby -rrbconfig -e "puts Config::CONFIG['sitelibdir']") +%define gemdir %(ruby -rubygems -e 'puts Gem::dir' 2>/dev/null) +%define gemname cobbler +%define geminstdir %{gemdir}/gems/%{gemname}-%{version} +%define installroot %{buildroot}%{geminstdir} + +Summary: An interface for interacting with a Cobbler server +Name: rubygem-%{gemname} +Version: 0.0.1 +Release: 1%{?dist} +Group: Development/Languages +License: LGPLv2+ or Ruby +URL: http://cobbler.et.redhat.com/ +Source0: http://fedorapeople.org/~mcpierce/%{gemname}-%{version}.gem +BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) +Requires: rubygems +BuildRequires: rubygems +BuildArch: noarch +Provides: rubygem(%{gemname}) = %{version} + +%description +Provides Ruby bindings to interact with a Cobbler server. + + +%prep + +%build + +%install +rm -rf %{buildroot} +mkdir -p %{buildroot}%{gemdir} +gem install --local --install-dir %{buildroot}%{gemdir} \ + --force %{SOURCE0} + +for file in %{installroot}/examples/*.rb; do chmod +x $file; done + +%clean +rm -rf %{buildroot} + +%files +%defattr(-, root, root, -) +%{gemdir}/gems/%{gemname}-%{version}/ +%{gemdir}/cache/%{gemname}-%{version}.gem +%{gemdir}/specifications/%{gemname}-%{version}.gemspec + +%doc %{geminstdir}/COPYING +%doc %{geminstdir}/NEWS +%doc %{geminstdir}/README + +%config %{geminstdir}/config/cobbler.yml + + +%changelog +* Mon Aug 04 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.1-1 +- Initial package diff --git a/contrib/ruby/test/test_base.rb b/contrib/ruby/test/test_base.rb new file mode 100644 index 00000000..5a31d659 --- /dev/null +++ b/contrib/ruby/test/test_base.rb @@ -0,0 +1,103 @@ +# test_system.rb - Unit tests. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + + +$:.unshift File.join(File.dirname(__FILE__),'..','lib') + +require 'test/unit' +require 'flexmock/test_unit' +require 'cobbler' + +module Cobbler + class TestBase < Test::Unit::TestCase + def setup + @connection = flexmock('connection') + Base.connection = @connection + Base.hostname = "localhost" + @username = 'dpierce' + @password = 'farkle' + Base.username = @username + Base.password = @password + end + + # Ensures that the default behavior for the base is to create a connection + # if one wasn't set. + # + def test_connection_without_mock + Base.connection = nil + + assert Base.connect(true), 'Should have created a new connection.' + + Base.connection = nil + + assert Base.connect(false), 'Should have created a new connection.' + end + + # Ensures that setting a mock connection works (for unit tests). + # + def test_connect + assert_same @connection, Base.connect(true), 'Got the wrong connection object.' + assert_same @connection, Base.connect(false), 'Got the wrong connection object.' + end + + # Ensures that beginning a transaction results in creating a connection. + # + def test_begin_transaction + assert_same @connection, Base.begin_transaction, 'Did not create a connection.' + end + + # Ensures that a login submits the username and password to the Cobbler server. + # + def test_login + @connection.should_receive(:call).with('login',@username, @password).once.returns(true) + + Base.login + end + + # Ensures that, if no connection exists, making a call throws an exception. + # + def test_make_call_without_connection + Base.connection = nil + + assert_raises(Exception) {Base.make_call('test')} + end + + # Ensures that making a call actually sends the data. + # + def test_make_call + @connection.should_receive(:call).with('test').once.returns('farkle') + + result = Base.make_call('test') + + assert_equal result, 'farkle', 'Did not get the expected result.' + end + + # Ensures that ending a transaction closes the connection. + # + def test_end_transaction + Base.end_transaction + + # we can't just call Base.connect since that will create a new object, + # so we'll try to send data and, if that raises an exception, we'll + # know indirectly that the connection object is gone. + assert_raises(Exception) {Base.make_call} + end + end +end diff --git a/contrib/ruby/test/test_distro.rb b/contrib/ruby/test/test_distro.rb new file mode 100644 index 00000000..6e114699 --- /dev/null +++ b/contrib/ruby/test/test_distro.rb @@ -0,0 +1,88 @@ +# +# To change this template, choose Tools | Templates +# and open the template in the editor. + + +$:.unshift File.join(File.dirname(__FILE__),'..','lib') + +require 'test/unit' +require 'flexmock/test_unit' +require 'cobbler' + +module Cobbler + class TestDistro < Test::Unit::TestCase + def setup + @connection = flexmock('connection') + Distro.connection = @connection + + @distros = Array.new + @distros << { + 'name' => 'Fedora-9-i386', + 'owners' => 'admin', + 'kernel' => '/var/www/cobbler/ks_mirror/Fedora-9-i386/images/pxeboot/vmlinuz', + 'breed' => 'redhat', + 'depth' => '0', + 'arch' => 'i386', + 'initrd' => '/var/www/cobbler/ks_mirror/Fedora-9-i386/images/pxeboot/initrd.img', + 'source_repos' => 'http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-i386-0.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-i386-1.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386', + 'kernel_options' => '', + 'parent' => '', + 'ks_meta' => 'treehttp://@@http_server@@/cblr/links/Fedora-9-i386' + } + + @distros << { + 'name' => 'Fedora-9-xen-i386', + 'owners' => 'admin', + 'kernel' => '/var/www/cobbler/ks_mirror/Fedora-9-xen-i386/images/pxeboot/vmlinuz', + 'breed' => 'redhat', + 'depth' => '0', + 'arch' => 'i386', + 'initrd' => '/var/www/cobbler/ks_mirror/Fedora-9-xen-i386/images/pxeboot/initrd.img', + 'source_repos' => 'http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-i386-0.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-i386-1.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386', + 'kernel_options' => '', + 'parent' => '', + 'ks_meta' => 'treehttp://@@http_server@@/cblr/links/Fedora-9-xen-i386' + } + + @distros << { + 'name' => 'Fedora-9-x86_64', + 'owners' => 'admin', + 'kernel' => '/var/www/cobbler/ks_mirror/Fedora-9-x86_64/images/pxeboot/vmlinuz', + 'breed' => 'redhat', + 'depth' => '0', + 'arch' => 'x86_64', + 'initrd' => '/var/www/cobbler/ks_mirror/Fedora-9-x86_64/images/pxeboot/initrd.img', + 'source_repos' => 'http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-x86_64-0.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-i386-1.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386', + 'kernel_options' => '', + 'parent' => '', + 'ks_meta' => 'treehttp://@@http_server@@/cblr/links/Fedora-9-x86_64' + } + + @distros << { + 'name' => 'Fedora-9-xen-x86_64', + 'owners' => 'admin', + 'kernel' => '/var/www/cobbler/ks_mirror/Fedora-9-xen-x86_64/images/pxeboot/vmlinuz', + 'breed' => 'redhat', + 'depth' => '0', + 'arch' => 'x86_64', + 'initrd' => '/var/www/cobbler/ks_mirror/Fedora-9-xen-x86_64/images/pxeboot/initrd.img', + 'source_repos' => 'http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-xen-x86_64-0.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386http://@@http_server@@/cobbler/ks_mirror/config/Fedora-9-i386-1.repohttp://@@http_server@@/cobbler/ks_mirror/Fedora-9-i386', + 'kernel_options' => '', + 'parent' => '', + 'ks_meta' => 'treehttp://@@http_server@@/cblr/links/Fedora-9-xen-x86_64' + } + + end + + # Ensures that finding all distros works as expected. + # + def test_find + @connection.should_receive(:call).with('get_distros').once.returns(@distros) + + result = Distro.find + + assert_equal @distros.size, result.size, 'Did not get the right number of distros back' + end + + end +end
\ No newline at end of file diff --git a/contrib/ruby/test/test_profile.rb b/contrib/ruby/test/test_profile.rb new file mode 100644 index 00000000..7d61c4e9 --- /dev/null +++ b/contrib/ruby/test/test_profile.rb @@ -0,0 +1,85 @@ +# test_profile.rb - Tests the Profile class. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + + +$:.unshift File.join(File.dirname(__FILE__),'..','lib') + +require 'test/unit' +require 'flexmock/test_unit' +require 'cobbler' + +module Cobbler + class TestProfile < Test::Unit::TestCase + def setup + @connection = flexmock('connection') + Profile.connection = @connection + Profile.hostname = "localhost" + + @profiles = Array.new + @profiles << { + 'profile' => 'Fedora-9-i386', + 'distro' => 'Fedora-9-i386', + 'dhcp tag' => 'default', + 'kernel options' => {}, + 'kickstart' => '/etc/cobbler/sample_end.ks', + 'ks metadata' => {}, + 'owners' => ['admin'], + 'repos' => [], + 'server' => '<<inherit>>', + 'virt bridge' => 'xenbr0', + 'virt cpus' => '1', + 'virt file size' => '5', + 'virt path' => '', + 'virt ram' => '512', + 'virt type' => 'xenpv', + } + + @profiles << { + 'profile' => 'Fedora-9-x86_64', + 'distro' => 'Fedora-9-x86_64', + 'dhcp tag' => 'default', + 'kernel options' => {}, + 'kickstart' => '/etc/cobbler/sample_end.ks', + 'ks metadata' => {}, + 'owners' => ['admin'], + 'repos' => [], + 'server' => '<<inherit>>', + 'virt bridge' => 'xenbr0', + 'virt cpus' => '1', + 'virt file size' => '5', + 'virt path' => '', + 'virt ram' => '512', + 'virt type' => 'xenpv', + } + + end + + # Ensures that an attempt to find all of a profile works as expected. + # + def test_find + @connection.should_receive(:call).with('get_profiles').once.returns(@profiles) + + result = Profile.find + + assert result, 'Expected a result set.' + assert_equal 2, result.size, 'Did not receive the right number of results' + end + end +end diff --git a/contrib/ruby/test/test_system.rb b/contrib/ruby/test/test_system.rb new file mode 100644 index 00000000..b56d564f --- /dev/null +++ b/contrib/ruby/test/test_system.rb @@ -0,0 +1,134 @@ +# test_system.rb - Tests the System class. +# +# Copyright (C) 2008 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce@redhat.com> +# +# 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; version 2 of the License. +# +# 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + + +$:.unshift File.join(File.dirname(__FILE__),'..','lib') + +require 'test/unit' +require 'flexmock/test_unit' +require 'cobbler' + +module Cobbler + class TestSystem < Test::Unit::TestCase + def setup + @connection = flexmock('connection') + Profile.connection = @connection + Profile.hostname = "localhost" + + @username = 'dpierce' + @password = 'farkle' + Profile.username = @username + Profile.password = @password + + @auth_token = 'OICU812B4' + @system_id = 717 + @new_system = 'system1' + @profile = 'profile1' + @nics = Array.new + @nic_details = {'mac_address' => '00:11:22:33:44:55:66:77'} + @nics << + NetworkInterface.new(@nic_details) + + @systems = Array.new + @systems << { + 'name' => 'Web-Server', + 'owners' => 'admin', + 'profile' => 'Fedora-9-i386', + 'depth' => '2', + 'virt_file_size' => '<<inherit>>', + 'virt_path' => '<<inherit>>', + 'virt_type' => '<<inherit>>', + 'server' => '<<inherit>>', + 'interfaces' => 'intf0dhcp_tagmac_address00:11:22:33:44:55subnetgatewayhostnamevirt_bridgeip_address', + 'virt_bridge' => '<<inherit>>', + 'virt_ram' => '<<inherit>>', + 'ks_meta' => nil, + 'netboot_enabled' => 'True', + 'kernel_options' => nil, + 'virt_cpus' => '<<inherit>>', + 'parent' => nil, + 'kickstart' => '<<inherit>>', + } + + @systems << { + 'name' => 'DNS-Server', + 'owners' => 'admin', + 'profile' => 'Fedora-9-x86_64', + 'depth' => '2', + 'virt_file_size' => '<<inherit>>', + 'virt_path' => '<<inherit>>', + 'virt_type' => '<<inherit>>', + 'server' => '<<inherit>>', + 'interfaces' => 'intf0dhcp_tagmac_address00:11:22:33:44:55subnetgatewayhostnamevirt_bridgeip_address', + 'virt_bridge' => '<<inherit>>', + 'virt_ram' => '<<inherit>>', + 'ks_meta' => nil, + 'netboot_enabled' => 'True', + 'kernel_options' => nil, + 'virt_cpus' => '<<inherit>>', + 'parent' => nil, + 'kickstart' => '<<inherit>>', + } + + end + + # Ensures that an attempt to find all profiles works as expected. + # + def test_find + @connection.should_receive(:call).with('get_systems').once.returns(@systems) + + result = System.find + + assert result, 'Expected a result set.' + assert_equal 2, result.size, 'Did not receive the right number of results' + end + + # Ensures that saving a system works as expected. + # + def test_save + @connection.should_receive(:call).with('login',@username,@password).once.returns(@auth_token) + @connection.should_receive(:call).with('new_system',@auth_token).once.returns(@system_id) + @connection.should_receive(:call).with('modify_system',@system_id,'name',@system_name,@auth_token).once.returns(true) + @connection.should_receive(:call).with('modify_system',@system_id,'profile',@profile_name,@auth_token).once.returns(true) + @connection.should_receive(:call).with('save_system',@system_id,@auth_token).once.returns(true) + + system = System.new(:name => @system_name, :profile => @profile_name) + + system.save + end + + # Ensures that saving a system works as expected even when network interfaces + # are involved. + # + def test_save + @connection.should_receive(:call).with('login',@username,@password).once.returns(@auth_token) + @connection.should_receive(:call).with('new_system',@auth_token).once.returns(@system_id) + @connection.should_receive(:call).with('modify_system',@system_id,'name',@system_name,@auth_token).once.returns(true) + @connection.should_receive(:call).with('modify_system',@system_id,'profile',@profile_name,@auth_token).once.returns(true) + @connection.should_receive(:call).with('modify_system',@system_id,'modify-interface',any,@auth_token).once.returns(true) + @connection.should_receive(:call).with('save_system',@system_id,@auth_token).once.returns(true) + + system = System.new(:name => @system_name, :profile => @profile_name) + system.interfaces = @nics + + system.save + end + end +end |