ruby-augeas 0.4.1

data/ext/augeas/extconf.rb

@@ -0,0 +1,30 @@
+## 
+#  extconf.rb: Ruby extension configuration
+#  
+#  Copyright (C) 200 Red Hat Inc.
+#  
+#  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
+#
+# Author: Bryan Kearney <bkearney@redhat.com>
+##
+require 'mkmf'
+
+extension_name = '_augeas'
+
+unless pkg_config("augeas")
+    raise "augeas-devel not installed"
+end
+
+create_makefile(extension_name)

data/lib/augeas.rb

@@ -0,0 +1,119 @@
+##
+#  augeas.rb: Ruby wrapper for augeas
+#
+#  Copyright (C) 2008 Red Hat Inc.
+#
+#  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
+#
+# Author: Bryan Kearney <bkearney@redhat.com>
+##
+
+require "_augeas"
+
+# Wrapper class for the augeas[http://augeas.net] library.
+class Augeas
+    private_class_method :new
+
+    class Error < RuntimeError; end
+
+    # Create a new Augeas instance and return it.
+    #
+    # Use +root+ as the filesystem root. If +root+ is +nil+, use the value
+    # of the environment variable +AUGEAS_ROOT+. If that doesn't exist
+    # either, use "/".
+    #
+    # +loadpath+ is a colon-spearated list of directories that modules
+    # should be searched in. This is in addition to the standard load path
+    # and the directories in +AUGEAS_LENS_LIB+
+    #
+    # +flags+ is a bitmask (see <tt>enum aug_flags</tt>)
+    #
+    # When a block is given, the Augeas instance is passed as the only
+    # argument into the block and closed when the block exits. In that
+    # case, the return value of the block is the return value of
+    # +open+. With no block, the Augeas instance is returned.
+    def self.open(root = nil, loadpath = nil, flags = NONE, &block)
+        aug = open3(root, loadpath, flags)
+        if block_given?
+            begin
+                rv = yield aug
+                return rv
+            ensure
+                aug.close
+            end
+        else
+            return aug
+        end
+    end
+
+    # Set one or multiple elemens to path.
+    # Multiple elements are mainly sensible with a path like
+    # .../array[last()+1], since this will append all elements.
+    def set(path, *values)
+        values.flatten.each { |v| set_internal(path, v) }
+    end
+
+    # The same as +set+, but raises <tt>Augeas::Error</tt> if setting fails
+    def set!(path, *values)
+        values.flatten.each do |v|
+            raise Augeas::Error unless set_internal(path, v)
+        end
+    end
+
+    # Clear the +path+, i.e. make its value +nil+
+    def clear(path)
+        set_internal(path, nil)
+    end
+
+    # Clear all transforms under <tt>/augeas/load</tt>. If +load+
+    # is called right after this, there will be no files
+    # under +/files+
+    def clear_transforms
+        rm("/augeas/load/*")
+    end
+
+    # Add a transform under <tt>/augeas/load</tt>
+    #
+    # The HASH can contain the following entries
+    # * <tt>:lens</tt> - the name of the lens to use
+    # * <tt>:name</tt> - a unique name; use the module name of the LENS when omitted
+    # * <tt>:incl</tt> - a list of glob patterns for the files to transform
+    # * <tt>:excl</tt> - a list of the glob patterns to remove from the list that matches <tt>:INCL</tt>
+    def transform(hash)
+        lens = hash[:lens]
+        name = hash[:name]
+        incl = hash[:incl]
+        excl = hash[:excl]
+        raise ArgumentError, "No lens specified" unless lens
+        raise ArgumentError, "No files to include" unless incl
+        name = lens.split(".")[0].sub("@", "") unless name
+
+        xfm = "/augeas/load/#{name}/"
+        set(xfm + "lens", lens)
+        set(xfm + "incl[last()+1]", incl)
+        set(xfm + "excl[last()+1]", excl) if excl
+    end
+
+    # The same as +save+, but raises <tt>Augeas::Error</tt> if saving fails
+    def save!
+        raise Augeas::Error unless save
+    end
+
+    # The same as +load+, but raises <tt>Augeas::Error</tt> if loading fails
+    def load!
+        raise Augeas::Error unless load
+    end
+
+end

data/tests/root/etc/group

@@ -0,0 +1,26 @@
+root:x:0:root
+bin:x:1:root,bin,daemon
+daemon:x:2:root,bin,daemon
+sys:x:3:root,bin,adm
+adm:x:4:root,adm,daemon
+tty:x:5:
+disk:x:6:root
+lp:x:7:daemon,lp
+mem:x:8:
+kmem:x:9:
+wheel:x:10:root
+mail:x:12:mail,postfix
+uucp:x:14:uucp
+man:x:15:
+games:x:20:
+gopher:x:30:
+dip:x:40:
+ftp:x:50:
+lock:x:54:
+nobody:x:99:
+users:x:100:
+floppy:x:19:
+vcsa:x:69:
+rpc:x:32:asfd
+rpcuser:x:29:
+nfsnobody:x:499:

data/tests/root/etc/hosts

@@ -0,0 +1,6 @@
+# Do not remove the following line, or various programs
+# that require network functionality will fail.
+127.0.0.1	localhost.localdomain	localhost galia.watzmann.net galia
+#172.31.122.254   granny.watzmann.net granny puppet
+#172.31.122.1     galia.watzmann.net galia
+172.31.122.14   orange.watzmann.net orange

data/tests/root/etc/inittab

@@ -0,0 +1,53 @@
+#
+# inittab       This file describes how the INIT process should set up
+#               the system in a certain run-level.
+#
+# Author:       Miquel van Smoorenburg, <miquels@drinkel.nl.mugnet.org>
+#               Modified for RHS Linux by Marc Ewing and Donnie Barnes
+#
+
+# Default runlevel. The runlevels used by RHS are:
+#   0 - halt (Do NOT set initdefault to this)
+#   1 - Single user mode
+#   2 - Multiuser, without NFS (The same as 3, if you do not have networking)
+#   3 - Full multiuser mode
+#   4 - unused
+#   5 - X11
+#   6 - reboot (Do NOT set initdefault to this)
+# 
+id:5:initdefault:
+
+# System initialization.
+si::sysinit:/etc/rc.d/rc.sysinit
+
+l0:0:wait:/etc/rc.d/rc 0
+l1:1:wait:/etc/rc.d/rc 1
+l2:2:wait:/etc/rc.d/rc 2
+l3:3:wait:/etc/rc.d/rc 3
+l4:4:wait:/etc/rc.d/rc 4
+l5:5:wait:/etc/rc.d/rc 5
+l6:6:wait:/etc/rc.d/rc 6
+
+# Trap CTRL-ALT-DELETE
+ca::ctrlaltdel:/sbin/shutdown -t3 -r now
+
+# When our UPS tells us power has failed, assume we have a few minutes
+# of power left.  Schedule a shutdown for 2 minutes from now.
+# This does, of course, assume you have powerd installed and your
+# UPS connected and working correctly.  
+pf::powerfail:/sbin/shutdown -f -h +2 "Power Failure; System Shutting Down"
+
+# If power was restored before the shutdown kicked in, cancel it.
+pr:12345:powerokwait:/sbin/shutdown -c "Power Restored; Shutdown Cancelled"
+
+
+# Run gettys in standard runlevels
+1:2345:respawn:/sbin/mingetty tty1
+2:2345:respawn:/sbin/mingetty tty2
+3:2345:respawn:/sbin/mingetty tty3
+4:2345:respawn:/sbin/mingetty tty4
+5:2345:respawn:/sbin/mingetty tty5
+6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon

data/tests/root/etc/ssh/sshd_config

@@ -0,0 +1,2 @@
+# Used by the test_span test
+Protocol 7

data/tests/tc_augeas.rb

@@ -0,0 +1,208 @@
+require 'test/unit'
+
+TOPDIR = File::expand_path(File::join(File::dirname(__FILE__), ".."))
+
+$:.unshift(File::join(TOPDIR, "lib"))
+$:.unshift(File::join(TOPDIR, "ext", "augeas"))
+
+require 'augeas'
+require 'fileutils'
+
+class TestAugeas < Test::Unit::TestCase
+
+    SRC_ROOT = File::expand_path(File::join(TOPDIR, "tests", "root")) + "/."
+    TST_ROOT = File::expand_path(File::join(TOPDIR, "build", "root")) + "/"
+
+    def test_basics
+        aug = aug_open(Augeas::SAVE_NEWFILE)
+        assert_equal("newfile", aug.get("/augeas/save"))
+        assert_equal(TST_ROOT, aug.get("/augeas/root"))
+
+        assert(aug.exists("/augeas/root"))
+        assert_not_nil(aug.get("/augeas/root"))
+        node = "/ruby/test/node"
+        assert_nothing_raised {
+            aug.set(node, "value")
+        }
+        assert_equal("value", aug.get(node))
+        assert_nothing_raised {
+            aug.clear(node)
+        }
+        assert_equal(nil, aug.get(node))
+        m = aug.match("/*")
+        ["/augeas", "/ruby"].each do |p|
+            assert(m.include?(p))
+            assert(aug.exists(p))
+        end
+    end
+
+    def test_no_new
+        assert_raise NoMethodError do
+            Augeas.new
+        end
+    end
+
+    def test_close
+        aug = Augeas::open("/tmp", nil, Augeas::SAVE_NEWFILE)
+        assert_equal("newfile", aug.get("/augeas/save"))
+        aug.close
+
+        assert_raise(SystemCallError) {
+            aug.get("/augeas/save")
+        }
+
+        assert_raise(SystemCallError) {
+            aug.close
+        }
+    end
+
+    def test_mv
+        Augeas::open("/dev/null") do |aug|
+            aug.set("/a/b", "value")
+            aug.mv("/a/b", "/x/y")
+            assert_equal("value", aug.get("/x/y"))
+        end
+    end
+
+    def test_load
+        aug = aug_open(Augeas::NO_LOAD)
+        assert_equal([], aug.match("/files/etc/*"))
+        aug.rm("/augeas/load/*");
+        assert_nothing_raised {
+            aug.load
+        }
+        assert_equal([], aug.match("/files/etc/*"))
+    end
+
+    def test_transform
+        aug = aug_open(Augeas::NO_LOAD)
+        aug.clear_transforms
+        aug.transform(:lens => "Hosts.lns",
+                      :incl => "/etc/hosts")
+        assert_raise(ArgumentError) {
+            aug.transform(:name => "Fstab",
+                          :incl => [ "/etc/fstab" ],
+                          :excl => [ "*~", "*.rpmnew" ])
+        }
+        aug.transform(:lens => "Inittab.lns",
+                      :incl => "/etc/inittab")
+        aug.transform(:lens => "Fstab.lns",
+                      :incl => "/etc/fstab*",
+                      :excl => "*~")
+        assert_equal(["/augeas/load/Fstab", "/augeas/load/Fstab/excl",
+                      "/augeas/load/Fstab/incl", "/augeas/load/Fstab/lens",
+                      "/augeas/load/Hosts", "/augeas/load/Hosts/incl",
+                      "/augeas/load/Hosts/lens", "/augeas/load/Inittab",
+                      "/augeas/load/Inittab/incl",
+                      "/augeas/load/Inittab/lens"],
+                     aug.match("/augeas/load//*").sort)
+        aug.load
+        assert_equal(["/files/etc/hosts", "/files/etc/inittab"],
+                     aug.match("/files/etc/*").sort)
+    end
+
+    def test_defvar
+        Augeas::open("/dev/null") do |aug|
+            aug.set("/a/b", "bval")
+            aug.set("/a/c", "cval")
+            assert aug.defvar("var", "/a/b")
+            assert_equal(["/a/b"], aug.match("$var"))
+            assert aug.defvar("var", nil)
+            assert_raises(SystemCallError) {
+                aug.match("$var")
+            }
+            assert ! aug.defvar("var", "/foo/")
+        end
+    end
+
+    def test_defnode
+        aug = aug_open
+        assert aug.defnode("x", "/files/etc/hosts/*[ipaddr = '127.0.0.1']", nil)
+        assert_equal(["/files/etc/hosts/1"], aug.match("$x"))
+    end
+
+    def test_save!
+        aug = aug_open
+        aug.set("/files/etc/hosts/1/garbage", "trash")
+        assert_raises(Augeas::Error) { aug.save! }
+    end
+
+    def test_set!
+        aug = aug_open
+        assert_raises(Augeas::Error) { aug.set!("files/etc/hosts/*", nil) }
+    end
+
+    def test_set
+       aug = aug_open
+       aug.set("/files/etc/group/disk/user[last()+1]",["user1","user2"])
+       assert_equal( aug.get("/files/etc/group/disk/user[1]"),"root" )
+       assert_equal( aug.get("/files/etc/group/disk/user[2]"),"user1" )
+       assert_equal( aug.get("/files/etc/group/disk/user[3]"),"user2" )
+
+       aug.set("/files/etc/group/new_group/user[last()+1]",
+	       "nuser1",["nuser2","nuser3"])
+       assert_equal( aug.get("/files/etc/group/new_group/user[1]"),"nuser1")
+       assert_equal( aug.get("/files/etc/group/new_group/user[2]"),"nuser2" )
+       assert_equal( aug.get("/files/etc/group/new_group/user[3]"),"nuser3" )
+
+       aug.rm("/files/etc/group/disk/user")
+       aug.set("/files/etc/group/disk/user[last()+1]","testuser")
+       assert_equal( aug.get("/files/etc/group/disk/user"),"testuser")
+
+       aug.rm("/files/etc/group/disk/user")
+       aug.set("/files/etc/group/disk/user[last()+1]", nil)
+       assert_equal( aug.get("/files/etc/group/disk/user"), nil)
+    end
+
+    def test_setm
+        aug = aug_open
+
+        aug.setm("/files/etc/group/*[label() =~ regexp(\"rpc.*\")]","users", "testuser1")
+        assert_equal( aug.get("/files/etc/group/rpc/users"), "testuser1")
+        assert_equal( aug.get("/files/etc/group/rpcuser/users"), "testuser1")
+
+        aug.setm("/files/etc/group/*[label() =~ regexp(\"rpc.*\")]/users",nil, "testuser2")
+        assert_equal( aug.get("/files/etc/group/rpc/users"), "testuser2")
+        assert_equal( aug.get("/files/etc/group/rpcuser/users"), "testuser2")
+    end
+
+    def test_error
+        aug = aug_open
+
+        # Cause an error
+        aug.get("/files/etc/hosts/*")
+        err = aug.error
+        assert_equal(Augeas::EMMATCH, err[:code])
+        assert err[:message]
+        assert err[:details]
+        assert err[:minor].nil?
+    end
+
+    def test_span
+        aug = aug_open
+
+        span = aug.span("/files/etc/ssh/sshd_config/Protocol")
+        assert_equal({}, span)
+
+        aug.set("/augeas/span", "enable")
+        aug.rm("/files/etc")
+        aug.load
+
+        span = aug.span("/files/etc/ssh/sshd_config/Protocol")
+        assert_not_nil(span[:filename])
+        assert_equal(29..37, span[:label])
+        assert_equal(38..39, span[:value])
+        assert_equal(29..40, span[:span])
+    end
+
+    private
+    def aug_open(flags = Augeas::NONE)
+        if File::directory?(TST_ROOT)
+            FileUtils::rm_rf(TST_ROOT)
+        end
+        FileUtils::mkdir_p(TST_ROOT)
+        FileUtils::cp_r(SRC_ROOT, TST_ROOT)
+
+        Augeas::open(TST_ROOT, nil, flags)
+    end
+end