Overview

NAME
    Csistck - Perl system consistency check framework

SYNOPSIS
        use Csistck;
    
        for my $host (qw/a b/) {
            host $host => role('test');
        }

        host 'c' => role('test');
    
        role 'test' => 
            template(".files/test.tt", "/tmp/test", { text => "Some text here" }),
            permission("/tmp/test*", mode => '0777', uid => 100, gid => 100);
    
        check;

    The script can then be called directly, using command line arguements
    below

DESCRIPTION
    Csistck is a small Perl framework for writing scripts to maintain system
    configuration and consistency. The focus of csistck is to stay
    lightweight, simple, and flexible.

METHODS
  option($name, $value)
    Set option to specified value.

   Available Options
    *  pkg_type [string]

       Set package type

    *  domain_name [string]

       Set default domain name to append to hosts

  host($hostname, [@tests]);
    Append test or array of tests to host definition.

        host 'hostname' => noop(1), noop(1);
        host 'hostname' => noop(0);

    Returns a reference to the host object.

  role($rolename, [@tests]);
    Append test or array of tests to role definition.

        role 'test' => noop(0);
        host 'hostname' => role('test');

    Returns a reference to the role object.

  noop($return)
    "No operation" test, used only for testing or placeholders.

        role 'test' => noop(1);

  file($glob, $target)
    Copy files matching file glob pattern to target directory.

        role 'test' => file("lighttpd/app/*.conf", "/etc/lighttpd");

    See Csistck::Test::File

  template($template, $target, [%args])
    Process file $template as a Template Toolkit template, output to path
    $target. Hashref %args is passed to the template processor.

        role 'test' => template("sys/motd", "/etc/motd", { hot => 'dog' });

    See Csistck::Test::Template

  permission($glob, %args)
    Change permissions on files matching file glob pattern

        role 'test' => permission("/etc/couchdb/*", {
          mode => '0640',
          uid => 130,
          gid => 130
        });

    See Csistck::Test::Permission

  script($script, [@arguments])
    Call script with specified arguments

        role 'test' => script("apache2/mod-check", "rewrite");

    See Csistck::Test::Script

  pkg($package, [$type])
    Check for package using system package manager.

        option 'pkg_type' => 'dpkg';
        role 'test' => pkg("lighttpd");

    See Csistck::Test::Pkg

SCRIPT USAGE
    Scripts based on csistck will run in an interactive mode by default. The
    following command line options are recognized in a csistck based script

    *   --[no]repair

        Automate repair mode, do not run in interactive mode.

    *   --[no]verbose

        Toggle verbose reporting of events

    *   --[no]debug

        Toggle debug reporting of events

    *   --[no]quiet

        Toggle event reporting of errors

AUTHOR
    Anthony Johnson, <anthony@ohess.org>

COPYRIGHT AND LICENSE
    Copyright (c) 2011 Anthony Johnson

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.